:delete` |
+
+ For example, creating a new Droplet by making a `POST` request to the
+ `/v2/droplets` endpoint requires the `droplet:create` scope while
+ listing Droplets by making a `GET` request to the `/v2/droplets`
+ endpoint requires the `droplet:read` scope.
+
+ Each endpoint below specifies which scope is required to access it when
+ using custom scopes.
+
### How to Authenticate with OAuth
In order to make an authenticated request, include a bearer-type
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_install_kubernetes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_install_kubernetes.yml
index 51180956b..2ae54f7d6 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_install_kubernetes.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_install_kubernetes.yml
@@ -40,4 +40,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - '1click:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_list.yml
index fe0be07b6..56c2319ef 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_list.yml
@@ -38,5 +38,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - '1click:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/account/account_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/account/account_get.yml
index e8f9ac38b..f60af09bf 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/account/account_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/account/account_get.yml
@@ -30,5 +30,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'account:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_get.yml
index 295adc49a..f0555a6c5 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_get.yml
@@ -37,5 +37,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'actions:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_list.yml
index 72f434655..305b33661 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_list.yml
@@ -37,5 +37,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'actions:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_assign_alertDestinations.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_assign_alertDestinations.yml
index 930b3062b..7ef1965ac 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_assign_alertDestinations.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_assign_alertDestinations.yml
@@ -45,4 +45,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'app:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_cancel_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_cancel_deployment.yml
index f9f2ed7fa..8974455ef 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_cancel_deployment.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_cancel_deployment.yml
@@ -36,4 +36,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'app:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_commit_rollback.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_commit_rollback.yml
index 34f398750..19d332036 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_commit_rollback.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_commit_rollback.yml
@@ -36,4 +36,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
\ No newline at end of file
+ - 'app:update'
\ No newline at end of file
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create.yml
index 8c14b82e8..3710e803f 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create.yml
@@ -58,4 +58,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'app:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_deployment.yml
index 58482fb14..2532d595b 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_deployment.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_deployment.yml
@@ -43,4 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'app:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_rollback.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_rollback.yml
index 0c3a4492f..331e582f3 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_rollback.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_rollback.yml
@@ -49,4 +49,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'app:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_delete.yml
index 9cc3f7e0c..c20e6bca5 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_delete.yml
@@ -37,4 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'app:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get.yml
index d351c4018..9774612a4 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get.yml
@@ -39,5 +39,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_deployment.yml
index b7c5fdce5..793a50d7c 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_deployment.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_deployment.yml
@@ -36,5 +36,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_instanceSize.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_instanceSize.yml
index d209791f5..0d05e74ef 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_instanceSize.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_instanceSize.yml
@@ -36,5 +36,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs.yml
index b36827f40..eef0bdf92 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs.yml
@@ -42,5 +42,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment.yml
index 22310ac03..1852cd51c 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment.yml
@@ -44,5 +44,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment_aggregate.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment_aggregate.yml
index 940593cb3..655c006f3 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment_aggregate.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment_aggregate.yml
@@ -43,5 +43,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_aggregate.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_aggregate.yml
index 941bd4f9d..cc4a3b0b8 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_aggregate.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_aggregate.yml
@@ -42,5 +42,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_metrics_bandwidth_usage.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_metrics_bandwidth_usage.yml
index 9a968f487..6823b20eb 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_metrics_bandwidth_usage.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_metrics_bandwidth_usage.yml
@@ -42,4 +42,4 @@ x-codeSamples:
security:
- bearer_auth:
- - read
+ - app:read
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_tier.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_tier.yml
index 1ccb9cf8d..bc681224d 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_tier.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_tier.yml
@@ -35,5 +35,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list.yml
index e5f54b2ba..56d4bfd9d 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list.yml
@@ -35,5 +35,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_alerts.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_alerts.yml
index bb5f962c2..f7d444126 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_alerts.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_alerts.yml
@@ -37,5 +37,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_deployments.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_deployments.yml
index 132c30b1f..4549855d4 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_deployments.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_deployments.yml
@@ -37,5 +37,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_instanceSizes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_instanceSizes.yml
index cae0b3a1b..b7b188f70 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_instanceSizes.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_instanceSizes.yml
@@ -29,5 +29,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_metrics_bandwidth_usage.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_metrics_bandwidth_usage.yml
index 9ca738082..df23cff44 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_metrics_bandwidth_usage.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_metrics_bandwidth_usage.yml
@@ -44,4 +44,4 @@ x-codeSamples:
security:
- bearer_auth:
- - read
+ - app:read
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_regions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_regions.yml
index a735b5cf3..22a356a0e 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_regions.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_regions.yml
@@ -29,5 +29,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_tiers.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_tiers.yml
index 09a560be0..d52113699 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_tiers.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_tiers.yml
@@ -29,5 +29,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'app:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_revert_rollback.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_revert_rollback.yml
index 20b900e22..a865fd59f 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_revert_rollback.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_revert_rollback.yml
@@ -37,4 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'app:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_update.yml
index e75dc7cad..0ee56fc3b 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_update.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_update.yml
@@ -43,4 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'app:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_appSpec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_appSpec.yml
index 139a178b7..b66c54608 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_appSpec.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_appSpec.yml
@@ -53,5 +53,5 @@ responses:
security:
- bearer_auth:
- - 'read'
+ - 'app:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_rollback.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_rollback.yml
index 25e9c03f5..9de830816 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_rollback.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_rollback.yml
@@ -46,4 +46,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
\ No newline at end of file
+ - 'app:update'
\ No newline at end of file
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_instance_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_instance_base.yml
index ee07369c0..6779982bf 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_instance_base.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_instance_base.yml
@@ -5,7 +5,7 @@ properties:
type: integer
format: int64
minimum: 1
- description: 'The amount of instances that this component should be scaled to. Default: 1'
+ description: 'The amount of instances that this component should be scaled to. Default: 1. Must not be set if autoscaling is used.'
default: 1
example: 2
@@ -25,3 +25,36 @@ properties:
- professional-xl
default: basic-xxs
example: basic-xxs
+
+ autoscaling:
+ description: Configuration for automatically scaling this component based on metrics.
+ type: object
+ properties:
+ min_instance_count:
+ description: The minimum amount of instances for this component. Must be less than max_instance_count.
+ type: integer
+ format: uint32
+ minimum: 1
+ example: 2
+ max_instance_count:
+ description: The maximum amount of instances for this component. Must be more than min_instance_count.
+ type: integer
+ format: uint32
+ minimum: 1
+ example: 3
+ metrics:
+ description: The metrics that the component is scaled on.
+ type: object
+ properties:
+ cpu:
+ description: Settings for scaling the component based on CPU utilization.
+ type: object
+ properties:
+ percent:
+ description: The average target CPU utilization for the component.
+ type: integer
+ format: uint32
+ minimum: 1
+ maximum: 100
+ default: 80
+ example: 75
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_propose_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_propose_response.yml
index 11ec59a0a..c4ab49f67 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_propose_response.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_propose_response.yml
@@ -44,3 +44,4 @@ properties:
monthly cost of the app if it were to use the Basic tier. If the proposed
app already uses the lest expensive tier, the field is empty.
example: 17
+ deprecated: true
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_image_source_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_image_source_spec.yml
index 453c658b7..0ac3dcc9f 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_image_source_spec.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_image_source_spec.yml
@@ -10,10 +10,20 @@ properties:
enum:
- DOCKER_HUB
- DOCR
+ - GHCR
description: |2-
- DOCKER_HUB: The DockerHub container registry type.
- DOCR: The DigitalOcean container registry type.
+ - GHCR: The Github container registry type.
example: DOCR
+
+ registry_credentials:
+ type: string
+ description: |2-
+ The credentials to be able to pull the image. The value will be encrypted on first submission. On following submissions, the encrypted value should be used.
+ - "$username:$access_token" for registries of type `DOCKER_HUB`.
+ - "$username:$access_token" for registries of type `GHCR`.
+ example: my-dockerhub-username:dckr_pat_the_access_token
repository:
type: string
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_instance_size.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_instance_size.yml
index d5aa7a0ea..e52e05942 100755
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_instance_size.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_instance_size.yml
@@ -23,6 +23,7 @@ properties:
title: The slug of the corresponding downgradable instance size on the lower tier
type: string
example: basic
+ deprecated: true
tier_slug:
title: The slug of the tier to which this instance size belongs
type: string
@@ -31,6 +32,7 @@ properties:
title: The slug of the corresponding upgradable instance size on the higher tier
type: string
example: basic
+ deprecated: true
usd_per_month:
title: The cost of this instance size in USD per month
type: string
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/parameters.yml
index cffc6f880..9697ded87 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/parameters.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/parameters.yml
@@ -98,6 +98,7 @@ log_type:
- BUILD: Build-time logs
- DEPLOY: Deploy-time logs
- RUN: Live run-time logs
+ - RUN_RESTARTED: Logs of crashed/restarted instances during runtime
in: query
name: type
required: true
@@ -108,6 +109,7 @@ log_type:
- BUILD
- DEPLOY
- RUN
+ - RUN_RESTARTED
type: string
example: BUILD
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/balance_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/balance_get.yml
index bfed76525..a4dc71b6e 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/balance_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/balance_get.yml
@@ -34,5 +34,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'billing:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/billingHistory_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/billingHistory_list.yml
index 1ca5f946f..a60eca6f0 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/billingHistory_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/billingHistory_list.yml
@@ -34,5 +34,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'billing:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_byUUID.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_byUUID.yml
index 6a41a86c2..354165834 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_byUUID.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_byUUID.yml
@@ -37,5 +37,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'billing:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_csvByUUID.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_csvByUUID.yml
index 2208eed78..d789bad31 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_csvByUUID.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_csvByUUID.yml
@@ -37,5 +37,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'billing:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_pdfByUUID.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_pdfByUUID.yml
index 026bf8cf0..69e5c3631 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_pdfByUUID.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_pdfByUUID.yml
@@ -37,5 +37,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'billing:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_summaryByUUID.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_summaryByUUID.yml
index 2e5af5fa4..a90ae4409 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_summaryByUUID.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_summaryByUUID.yml
@@ -38,5 +38,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'billing:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_list.yml
index 97fb597d3..dd626e772 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_list.yml
@@ -35,5 +35,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'billing:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_preview.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_preview.yml
index 3444a2eb9..ca08b5818 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_preview.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_preview.yml
@@ -8,6 +8,11 @@ properties:
description: >-
The UUID of the invoice. The canonical reference for the invoice.
example: fdabb512-6faf-443c-ba2e-665452332a9e
+ invoice_id:
+ type: string
+ description: >-
+ ID of the invoice. Listed on the face of the invoice PDF as the "Invoice number".
+ example: "123456789"
amount:
type: string
description: >-
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_summary.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_summary.yml
index d60b00768..93ec7ab9f 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_summary.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_summary.yml
@@ -6,6 +6,11 @@ properties:
description: UUID of the invoice
example: 22737513-0ea7-4206-8ceb-98a575af7681
+ invoice_id:
+ type: string
+ description: ID of the invoice
+ example: '123456789'
+
billing_period:
type: string
description: >-
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoice_summary.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoice_summary.yml
index 1c075398c..7843cd759 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoice_summary.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoice_summary.yml
@@ -16,6 +16,7 @@ content:
$ref: '../models/invoice_summary.yml'
example:
invoice_uuid: 22737513-0ea7-4206-8ceb-98a575af7681
+ invoice_id: '123456789'
billing_period: 2020-01
amount: '27.13'
user_name: Sammy Shark
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoices.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoices.yml
index 3ffcdc801..d4f142a89 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoices.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoices.yml
@@ -34,13 +34,16 @@ content:
example:
invoices:
- invoice_uuid: 22737513-0ea7-4206-8ceb-98a575af7681
+ invoice_id: '12345678'
amount: '12.34'
invoice_period: 2019-12
- invoice_uuid: fdabb512-6faf-443c-ba2e-665452332a9e
+ invoice_id: '23456789'
amount: '23.45'
invoice_period: 2019-11
invoice_preview:
invoice_uuid: 1afe95e6-0958-4eb0-8d9a-9c5060d3ef03
+ invoice_id: '34567890'
amount: '34.56'
invoice_period: 2020-02
updated_at: '2020-02-23T06:31:50Z'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_create_endpoint.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_create_endpoint.yml
index 7ef3abbb5..39367c575 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_create_endpoint.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_create_endpoint.yml
@@ -59,4 +59,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'cdn:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_delete_endpoint.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_delete_endpoint.yml
index 64f0e3c6c..dc8006fa4 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_delete_endpoint.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_delete_endpoint.yml
@@ -42,4 +42,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'cdn:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_get_endpoint.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_get_endpoint.yml
index a4cfc90a1..9a14842b7 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_get_endpoint.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_get_endpoint.yml
@@ -39,5 +39,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'cdn:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_list_endpoints.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_list_endpoints.yml
index e80112637..896fd69cc 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_list_endpoints.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_list_endpoints.yml
@@ -37,5 +37,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'cdn:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_purge_cache.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_purge_cache.yml
index 2561aeed5..058322535 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_purge_cache.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_purge_cache.yml
@@ -52,4 +52,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'cdn:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_update_endpoint.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_update_endpoint.yml
index b27aedc69..65752fa5a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_update_endpoint.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_update_endpoint.yml
@@ -48,4 +48,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'cdn:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_create.yml
index 3cd9bef4f..fd5bf952d 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_create.yml
@@ -50,4 +50,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'certificate:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_delete.yml
index b755cc3dd..d51c982c3 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_delete.yml
@@ -39,4 +39,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'certificate:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_get.yml
index 85c99f5de..94c98ef7a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_get.yml
@@ -39,5 +39,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'cdn:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_list.yml
index 0b7aced28..5ca386d4c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_list.yml
@@ -9,6 +9,7 @@ description: >-
parameters:
- $ref: '../../shared/parameters.yml#/per_page'
- $ref: '../../shared/parameters.yml#/page'
+ - $ref: "parameters.yml#/certificate_name"
tags:
- Certificates
@@ -37,5 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'cdn:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/parameters.yml
index df1d84899..cd79d82a5 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/parameters.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/parameters.yml
@@ -7,4 +7,14 @@ certificate_id:
type: string
format: uuid
minimum: 1
- example: 4de7ac8b-495b-4884-9a69-1050c6793cd6
\ No newline at end of file
+ example: 4de7ac8b-495b-4884-9a69-1050c6793cd6
+
+certificate_name:
+ name: name
+ in: query
+ description: Name of expected certificate
+ required: false
+ schema:
+ type: string
+ default: ""
+ example: "certificate-name"
\ No newline at end of file
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add.yml
index ce3f73fa2..6dff7e48d 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add.yml
@@ -52,4 +52,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_connectionPool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_connectionPool.yml
index 263e7b8bd..c2500da3a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_connectionPool.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_connectionPool.yml
@@ -59,4 +59,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_user.yml
index 792daf61d..6c73a9c4b 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_user.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_user.yml
@@ -38,7 +38,8 @@ requestBody:
example: true
description: |
For MongoDB clusters, set to `true` to create a read-only user.
- This option is not currently supported for other database engines.
+ This option is not currently supported for other database engines.
+
examples:
Add New User:
value:
@@ -54,6 +55,12 @@ requestBody:
value:
name: my-readonly
readonly: true
+
+ Add New User for Postgres with replication rights:
+ value:
+ name: app-02
+ settings:
+ pg_allow_replication: true
Add New User with Kafka ACLs:
value:
@@ -93,4 +100,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml
index f065dc011..11868c762 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml
@@ -11,8 +11,12 @@ description: >-
`creating`. When the cluster is ready to receive traffic, this will transition to
`online`.
+
The embedded `connection` and `private_connection` objects will contain the
- information needed to access the database cluster.
+ information needed to access the database cluster. For multi-node clusters, the
+ `standby_connection` and `standby_private_connection` objects will contain the information
+ needed to connect to the cluster's standby node(s).
+
DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups.
To create a new database cluster based on a backup of an existing cluster, send a POST
@@ -109,4 +113,4 @@ x-codeSamples:
security:
- bearer_auth:
- - "write"
+ - "database:create"
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_topic.yml
index ae0333bb5..0dfd7d632 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_topic.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_topic.yml
@@ -55,4 +55,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_replica.yml
index b1c9cf465..5a71d1872 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_replica.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_replica.yml
@@ -66,4 +66,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete.yml
index 81c248b76..adb2bf8a5 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete.yml
@@ -44,4 +44,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_connectionPool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_connectionPool.yml
index ac6cb1ff0..5fc2ccc31 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_connectionPool.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_connectionPool.yml
@@ -41,4 +41,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_topic.yml
index eb597fde9..53dd22672 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_topic.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_topic.yml
@@ -41,5 +41,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
-
+ - 'database:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_onlineMigration.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_onlineMigration.yml
index f1d5581a8..6d474bc80 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_onlineMigration.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_onlineMigration.yml
@@ -38,4 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_user.yml
index c13a01daf..432c6d38f 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_user.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_user.yml
@@ -44,4 +44,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_cluster.yml
index e1ef8b007..0c44efbda 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_cluster.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_cluster.yml
@@ -41,4 +41,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_replica.yml
index e9c7d3a22..105ae1152 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_replica.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_replica.yml
@@ -46,4 +46,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_events_logs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_events_logs.yml
new file mode 100644
index 000000000..4ff4161d7
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_events_logs.yml
@@ -0,0 +1,42 @@
+operationId: databases_list_events_logs
+
+summary: List all Events Logs
+
+description: |
+ To list all of the cluster events, send a GET request to
+ `/v2/databases/$DATABASE_ID/events`.
+
+ The result will be a JSON object with a `events` key.
+
+tags:
+ - Databases
+
+parameters:
+ - $ref: "parameters.yml#/database_cluster_uuid"
+
+responses:
+ "200":
+ $ref: "responses/events_logs.yml"
+
+ "401":
+ $ref: "../../shared/responses/unauthorized.yml"
+
+ "404":
+ $ref: "../../shared/responses/not_found.yml"
+
+ "429":
+ $ref: "../../shared/responses/too_many_requests.yml"
+
+ "500":
+ $ref: "../../shared/responses/server_error.yml"
+
+ default:
+ $ref: "../../shared/responses/unexpected_error.yml"
+
+x-codeSamples:
+ - $ref: "examples/curl/databases_list_events.yml"
+ - $ref: "examples/go/databases_list_events.yml"
+
+security:
+ - bearer_auth:
+ - "database:read"
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get.yml
index 83b39861f..92e5f2d8b 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get.yml
@@ -44,5 +44,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_ca.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_ca.yml
index 10f47d434..b6bc401fe 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_ca.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_ca.yml
@@ -41,5 +41,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster.yml
index 8d816e096..a2920d19c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster.yml
@@ -6,11 +6,16 @@ description: >-
To show information about an existing database cluster, send a GET request to
`/v2/databases/$DATABASE_ID`.
+
The response will be a JSON object with a database key. This will be set to an object
containing the standard database cluster attributes.
- The embedded connection and private_connection objects will contain the information
- needed to access the database cluster.
+
+ The embedded `connection` and `private_connection` objects will contain the
+ information needed to access the database cluster. For multi-node clusters, the
+ `standby_connection` and `standby_private_connection` objects contain the information
+ needed to connect to the cluster's standby node(s).
+
The embedded maintenance_window object will contain information about any scheduled
maintenance for the database cluster.
@@ -47,5 +52,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster_metrics_credentials.yml
new file mode 100644
index 000000000..6e281f43c
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster_metrics_credentials.yml
@@ -0,0 +1,38 @@
+operationId: databases_get_cluster_metrics_credentials
+
+summary: Retrieve Database Clusters' Metrics Endpoint Credentials
+
+description: >-
+ To show the credentials for all database clusters' metrics endpoints, send a GET request to
+ `/v2/databases/metrics/credentials`. The result will be a JSON object with a `credentials` key.
+
+tags:
+ - Databases
+
+responses:
+ '200':
+ $ref: 'responses/database_metrics_auth.yml'
+
+ '401':
+ $ref: '../../shared/responses/unauthorized.yml'
+
+ '404':
+ $ref: '../../shared/responses/not_found.yml'
+
+ '429':
+ $ref: '../../shared/responses/too_many_requests.yml'
+
+ '500':
+ $ref: '../../shared/responses/server_error.yml'
+
+ default:
+ $ref: '../../shared/responses/unexpected_error.yml'
+
+x-codeSamples:
+ - $ref: 'examples/curl/databases_get_cluster_metrics_credentials.yml'
+ - $ref: 'examples/go/databases_get_cluster_metrics_credentials.yml'
+
+security:
+ - bearer_auth:
+ - 'database:update'
+
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_config.yml
index 439bfc8f9..b2d5d2faf 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_config.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_config.yml
@@ -38,5 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_connectionPool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_connectionPool.yml
index 083be2b0e..ecf54d41f 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_connectionPool.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_connectionPool.yml
@@ -42,5 +42,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_evictionPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_evictionPolicy.yml
index 2cc3c9d4f..b4cb5bcdc 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_evictionPolicy.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_evictionPolicy.yml
@@ -41,4 +41,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_topic.yml
index 3ce862088..85565e194 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_topic.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_topic.yml
@@ -40,5 +40,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_migrationStatus.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_migrationStatus.yml
index 95d70d99b..38f9f4f75 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_migrationStatus.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_migrationStatus.yml
@@ -37,5 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_replica.yml
index f58f5adff..daf063597 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_replica.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_replica.yml
@@ -46,5 +46,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_sql_mode.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_sql_mode.yml
index b7f42c8cd..1534c8d7b 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_sql_mode.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_sql_mode.yml
@@ -41,5 +41,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_user.yml
index 94e20e2ca..126562fe6 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_user.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_user.yml
@@ -49,5 +49,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list.yml
index d1e08f463..0b79b2981 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list.yml
@@ -43,5 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_backups.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_backups.yml
index 84f919695..b01fff1dc 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_backups.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_backups.yml
@@ -44,5 +44,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_clusters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_clusters.yml
index 7e3ad4fc3..63c3e6562 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_clusters.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_clusters.yml
@@ -7,11 +7,15 @@ description: >-
`/v2/databases`. To limit the results to database clusters with a specific tag, include
the `tag_name` query parameter set to the name of the tag. For example, `/v2/databases?tag_name=$TAG_NAME`.
+
The result will be a JSON object with a `databases` key. This will be set to an array of database objects,
each of which will contain the standard database attributes.
+
The embedded `connection` and `private_connection` objects will contain the information needed to access the
- database cluster:
+ database cluster. For multi-node clusters, the `standby_connection` and `standby_private_connection` objects
+ will contain the information needed to connect to the cluster's standby node(s).
+
The embedded `maintenance_window` object will contain information about any scheduled maintenance for the
database cluster.
@@ -48,5 +52,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_connectionPools.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_connectionPools.yml
index 14b30021d..329b3a1a3 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_connectionPools.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_connectionPools.yml
@@ -41,5 +41,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_firewall_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_firewall_rules.yml
index e6e2da22b..b892c9664 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_firewall_rules.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_firewall_rules.yml
@@ -41,5 +41,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_topics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_topics.yml
index 3bdb19f39..37e84f5d0 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_topics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_topics.yml
@@ -39,5 +39,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_options.yml
index c4a89bb87..7be7fa908 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_options.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_options.yml
@@ -37,5 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_replicas.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_replicas.yml
index 05ce8dcab..236d48b11 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_replicas.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_replicas.yml
@@ -46,5 +46,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_users.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_users.yml
index 1c52c364d..256caef8d 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_users.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_users.yml
@@ -45,5 +45,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_patch_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_patch_config.yml
index 212de2857..429747acc 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_patch_config.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_patch_config.yml
@@ -47,4 +47,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_promote_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_promote_replica.yml
index 34df5a28f..c961e3610 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_promote_replica.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_promote_replica.yml
@@ -46,4 +46,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_reset_auth.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_reset_auth.yml
index 137bd6bcd..f1261887b 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_reset_auth.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_reset_auth.yml
@@ -59,4 +59,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_clusterSize.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_clusterSize.yml
index 03adabd5b..20a5d343a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_clusterSize.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_clusterSize.yml
@@ -57,4 +57,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_cluster_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_cluster_metrics_credentials.yml
new file mode 100644
index 000000000..45c9e2339
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_cluster_metrics_credentials.yml
@@ -0,0 +1,46 @@
+operationId: databases_update_cluster_metrics_credentials
+
+summary: Update Database Clusters' Metrics Endpoint Credentials
+
+description: >-
+ To update the credentials for all database clusters' metrics endpoints, send a PUT request to
+ `/v2/databases/metrics/credentials`. A successful request will receive a 204 No Content status code
+ with no body in response.
+
+tags:
+ - Databases
+
+requestBody:
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: 'models/database_metrics_credentials.yml'
+ example:
+ credentials:
+ basic_auth_username: "new_username"
+ basic_auth_password: "new_password"
+
+responses:
+ '204':
+ $ref: '../../shared/responses/no_content.yml'
+
+ '401':
+ $ref: '../../shared/responses/unauthorized.yml'
+
+ '429':
+ $ref: '../../shared/responses/too_many_requests.yml'
+
+ '500':
+ $ref: '../../shared/responses/server_error.yml'
+
+ default:
+ $ref: '../../shared/responses/unexpected_error.yml'
+
+x-codeSamples:
+ - $ref: 'examples/curl/databases_update_cluster_metrics_credentials.yml'
+ - $ref: 'examples/go/databases_update_cluster_metrics_credentials.yml'
+
+security:
+ - bearer_auth:
+ - 'database:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_connectionPool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_connectionPool.yml
index d40ba7f2d..f4f65f86e 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_connectionPool.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_connectionPool.yml
@@ -51,5 +51,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'database:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_evictionPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_evictionPolicy.yml
index 1b494a197..e6e8f92b1 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_evictionPolicy.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_evictionPolicy.yml
@@ -53,4 +53,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_firewall_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_firewall_rules.yml
index f9c03af22..5661f2f6a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_firewall_rules.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_firewall_rules.yml
@@ -71,4 +71,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_topic.yml
index b68f9b468..8d301053b 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_topic.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_topic.yml
@@ -53,5 +53,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_maintenanceWindow.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_maintenanceWindow.yml
index 4728576fc..80587c784 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_maintenanceWindow.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_maintenanceWindow.yml
@@ -52,4 +52,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_onlineMigration.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_onlineMigration.yml
index 0951c3e45..31c699597 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_onlineMigration.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_onlineMigration.yml
@@ -58,4 +58,4 @@ x-codeSamples:
security:
- bearer_auth:
- - "write"
+ - "database:update"
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_region.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_region.yml
index d14715ae4..8edce356d 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_region.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_region.yml
@@ -62,4 +62,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_sql_mode.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_sql_mode.yml
index 53071dfcd..2003d0894 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_sql_mode.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_sql_mode.yml
@@ -52,4 +52,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_user.yml
new file mode 100644
index 000000000..821805489
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_user.yml
@@ -0,0 +1,75 @@
+operationId: databases_update_user
+
+summary: Update a Database User
+
+description: |
+ To update an existing database user, send a PUT request to `/v2/databases/$DATABASE_ID/users/$USERNAME`
+ with the desired settings.
+
+ **Note**: only `settings` can be updated via this type of request. If you wish to change the name of a user,
+ you must recreate a new user.
+
+ The response will be a JSON object with a key called `user`. The value of this will be an
+ object that contains the name of the update database user, along with the `settings` object that
+ has been updated.
+
+tags:
+ - Databases
+
+parameters:
+ - $ref: 'parameters.yml#/database_cluster_uuid'
+ - $ref: 'parameters.yml#/username'
+
+requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - type: object
+ properties:
+ settings:
+ $ref: './models/user_settings.yml'
+ required:
+ - settings
+ examples:
+ Update User Kafka ACLs:
+ value:
+ settings:
+ acl:
+ - id: acl128aaaa99239
+ permission: produceconsume
+ topic: customer-events
+ - id: acl293098flskdf
+ permission: produce
+ topic: customer-events.*
+ - id: acl128ajei20123
+ permission: consume
+ topic: customer-events
+
+responses:
+ '201':
+ $ref: 'responses/user.yml'
+
+ '401':
+ $ref: '../../shared/responses/unauthorized.yml'
+
+ '404':
+ $ref: '../../shared/responses/not_found.yml'
+
+ '429':
+ $ref: '../../shared/responses/too_many_requests.yml'
+
+ '500':
+ $ref: '../../shared/responses/server_error.yml'
+
+ default:
+ $ref: '../../shared/responses/unexpected_error.yml'
+
+x-codeSamples:
+ - $ref: 'examples/curl/databases_update_user.yml'
+ - $ref: 'examples/go/databases_update_user.yml'
+
+security:
+ - bearer_auth:
+ - 'database:update'
\ No newline at end of file
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_upgrade_major_version.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_upgrade_major_version.yml
index 921d10301..2413b8ae1 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_upgrade_major_version.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_upgrade_major_version.yml
@@ -50,4 +50,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'database:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_get_cluster_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_get_cluster_metrics_credentials.yml
new file mode 100644
index 000000000..fb4f6f375
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_get_cluster_metrics_credentials.yml
@@ -0,0 +1,6 @@
+lang: cURL
+source: |-
+ curl -X GET \
+ -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
+ "https://api.digitalocean.com/v2/databases/metrics/credentials"
+
\ No newline at end of file
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_list_events.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_list_events.yml
new file mode 100644
index 000000000..c42ad2a1e
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_list_events.yml
@@ -0,0 +1,6 @@
+lang: cURL
+source: |-
+ curl -X GET \
+ -H "Content-Type: application/json" \
+ -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
+ "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/events"
\ No newline at end of file
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_cluster_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_cluster_metrics_credentials.yml
new file mode 100644
index 000000000..be29c0623
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_cluster_metrics_credentials.yml
@@ -0,0 +1,8 @@
+lang: cURL
+source: |-
+ curl -X PUT \
+ -H "Content-Type: application/json" \
+ -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
+ -d '{"credentials": {"basic_auth_username": "new_username", "basic_auth_password": "new_password"}}'\
+ "https://api.digitalocean.com/v2/databases/metrics/credentials"
+
\ No newline at end of file
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_user.yml
new file mode 100644
index 000000000..6f3247e04
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_user.yml
@@ -0,0 +1,7 @@
+lang: cURL
+source: |-
+ curl -X PUT \
+ -H "Content-Type: application/json" \
+ -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
+ -d '{"settings": {"acl": [{"topic": "events", "permission": "produce"}]}}' \
+ "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/users"
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_get_cluster_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_get_cluster_metrics_credentials.yml
new file mode 100644
index 000000000..c9dab0468
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_get_cluster_metrics_credentials.yml
@@ -0,0 +1,17 @@
+lang: Go
+source: |-
+ import (
+ "context"
+ "os"
+
+ "github.com/digitalocean/godo"
+ )
+
+ func main() {
+ token := os.Getenv("DIGITALOCEAN_TOKEN")
+
+ client := godo.NewFromToken(token)
+ ctx := context.TODO()
+
+ creds, _, _ := client.Databases.GetMetricsCredentials(ctx)
+ }
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_list_events.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_list_events.yml
new file mode 100644
index 000000000..de3036523
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_list_events.yml
@@ -0,0 +1,17 @@
+lang: Go
+source: |-
+ import (
+ "context"
+ "os"
+
+ "github.com/digitalocean/godo"
+ )
+
+ func main() {
+ token := os.Getenv("DIGITALOCEAN_TOKEN")
+
+ client := godo.NewFromToken(token)
+ ctx := context.TODO()
+
+ replicas, _, err := client.Databases.ListProjectEvents(ctx, "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", nil)
+ }
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_cluster_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_cluster_metrics_credentials.yml
new file mode 100644
index 000000000..ba5595690
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_cluster_metrics_credentials.yml
@@ -0,0 +1,22 @@
+lang: Go
+source: |-
+ import (
+ "context"
+ "os"
+
+ "github.com/digitalocean/godo"
+ )
+
+ func main() {
+ token := os.Getenv("DIGITALOCEAN_TOKEN")
+
+ client := godo.NewFromToken(token)
+ ctx := context.TODO()
+
+ _, _ = client.Databases.UpdateMetricsCredentials(ctx, &godo.DatabaseUpdateMetricsCredentialsRequest{
+ Credentials: &godo.DatabaseMetricsCredentials{
+ BasicAuthUsername: "a_new_username",
+ BasicAuthPassword: "a_new_password",
+ },
+ })
+ }
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_user.yml
new file mode 100644
index 000000000..670df07cb
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_user.yml
@@ -0,0 +1,33 @@
+lang: Go
+source: |-
+ import (
+ "context"
+ "os"
+
+ "github.com/digitalocean/godo"
+ )
+
+ func main() {
+ token := os.Getenv("DIGITALOCEAN_TOKEN")
+
+ client := godo.NewFromToken(token)
+ ctx := context.TODO()
+ userName := "test-user"
+
+ updateUserRequest := &godo.DatabaseUpdateUserRequest{
+ Settings: {
+ ACL: [
+ {
+ Permssion: "consume",
+ Topic: "events",
+ }
+ {
+ Permission: "produce",
+ Topic: "metrics",
+ }
+ ]
+ }
+ }
+
+ user, _, err := client.Databases.UpdateUser(ctx, "88055188-9e54-4f21-ab11-8a918ed79ee2", userName, updateUserRequest)
+ }
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/connection_pool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/connection_pool.yml
index 8b0db3afc..afc8c1b91 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/connection_pool.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/connection_pool.yml
@@ -42,6 +42,14 @@ properties:
allOf:
- $ref: './database_connection.yml'
- readOnly: true
+ standby_connection:
+ allOf:
+ - $ref: './database_connection.yml'
+ - readOnly: true
+ standby_private_connection:
+ allOf:
+ - $ref: './database_connection.yml'
+ - readOnly: true
required:
- name
- mode
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml
index 59e564b37..e0085dc5f 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml
@@ -20,10 +20,11 @@ properties:
- redis
- mongodb
- kafka
+ - opensearch
description: >-
A slug representing the database engine used for the cluster. The possible values
are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB,
- and "kafka" for Kafka.
+ "kafka" for Kafka and "opensearch" for Opensearch.
version:
type: string
example: '8'
@@ -92,6 +93,12 @@ properties:
description: >-
An array of strings containing the names of databases created in the
database cluster.
+ ui_connection:
+ allOf:
+ - $ref: './opensearch_connection.yml'
+ - readOnly: true
+ description: >-
+ The connection details for OpenSearch dashboard.
connection:
allOf:
- $ref: './database_connection.yml'
@@ -100,6 +107,14 @@ properties:
allOf:
- $ref: './database_connection.yml'
- readOnly: true
+ standby_connection:
+ allOf:
+ - $ref: './database_connection.yml'
+ - readOnly: true
+ standby_private_connection:
+ allOf:
+ - $ref: './database_connection.yml'
+ - readOnly: true
users:
type: array
nullable: true
@@ -139,6 +154,15 @@ properties:
description: >-
Additional storage added to the cluster, in MiB. If null, no additional storage is added to the cluster, beyond
what is provided as a base amount from the 'size' and any previously added additional storage.
+ metrics_endpoints:
+ type: array
+ items:
+ $ref: './database_service_endpoint.yml'
+ description: >-
+ Public hostname and port of the cluster's metrics endpoint(s). Includes one record for the cluster's primary node and
+ a second entry for the cluster's standby node(s).
+ readOnly: true
+
required:
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml
index 23564797b..61282ddbf 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml
@@ -6,3 +6,5 @@ properties:
- $ref: './mysql.yml'
- $ref: './postgres.yml'
- $ref: './redis.yml'
+ - $ref: './mongo.yml'
+ - $ref: './kafka.yml'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_metrics_credentials.yml
new file mode 100644
index 000000000..973806675
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_metrics_credentials.yml
@@ -0,0 +1,5 @@
+type: object
+
+properties:
+ credentials:
+ $ref: "./databases_basic_auth_credentials.yml"
\ No newline at end of file
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_service_endpoint.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_service_endpoint.yml
new file mode 100644
index 000000000..86002a7e8
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_service_endpoint.yml
@@ -0,0 +1,13 @@
+type: object
+
+properties:
+ host:
+ type: string
+ description: A FQDN pointing to the database cluster's node(s).
+ example: backend-do-user-19081923-0.db.ondigitalocean.com
+ readOnly: true
+ port:
+ type: integer
+ description: The port on which a service is listening.
+ example: 9273
+ readOnly: true
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/databases_basic_auth_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/databases_basic_auth_credentials.yml
new file mode 100644
index 000000000..13cc3d444
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/databases_basic_auth_credentials.yml
@@ -0,0 +1,11 @@
+type: object
+
+properties:
+ basic_auth_username:
+ type: string
+ example: username
+ description: basic authentication username for metrics HTTP endpoint
+ basic_auth_password:
+ type: string
+ example: password
+ description: basic authentication password for metrics HTTP endpoint
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/events_logs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/events_logs.yml
new file mode 100644
index 000000000..a0b57c1b6
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/events_logs.yml
@@ -0,0 +1,27 @@
+type: object
+
+properties:
+ id:
+ type: string
+ description: ID of the particular event.
+ example: 'pe8u2huh'
+ cluster_name:
+ type: string
+ description: The name of cluster.
+ example: 'sample_cluster'
+ event_type:
+ type: string
+ enum:
+ - cluster_maintenance_perform
+ - cluster_master_promotion
+ - cluster_create
+ - cluster_update
+ - cluster_delete
+ - cluster_poweron
+ - cluster_poweroff
+ description: Type of the event.
+ example: 'cluster_create'
+ create_time:
+ type: string
+ description: The time of the generation of a event.
+ example: '2020-10-29T15:57:38Z'
\ No newline at end of file
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka.yml
new file mode 100644
index 000000000..a9e9b959f
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka.yml
@@ -0,0 +1,328 @@
+type: object
+
+properties:
+ compression_type:
+ description: >-
+ Specify the final compression type for a given topic. This
+ configuration accepts the standard compression codecs ('gzip', 'snappy',
+ 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent
+ to no compression; and 'producer' which means retain the original
+ compression codec set by the producer.
+ type: string
+ enum:
+ - gzip
+ - snappy
+ - lz4
+ - zstd
+ - uncompressed
+ - producer
+ example: gzip
+ group_initial_rebalance_delay_ms:
+ description: >-
+ The amount of time, in milliseconds, the group coordinator
+ will wait for more consumers to join a new group before performing
+ the first rebalance. A longer delay means potentially fewer rebalances,
+ but increases the time until processing begins. The default value
+ for this is 3 seconds. During development and testing it might be
+ desirable to set this to 0 in order to not delay test execution time.
+ type: integer
+ example: 3000
+ minimum: 0
+ maximum: 300000
+ group_min_session_timeout_ms:
+ description: >-
+ The minimum allowed session timeout for registered consumers.
+ Longer timeouts give consumers more time to process messages in between
+ heartbeats at the cost of a longer time to detect failures.
+ type: integer
+ example: 6000
+ minimum: 0
+ maximum: 60000
+ group_max_session_timeout_ms:
+ description: >-
+ The maximum allowed session timeout for registered consumers.
+ Longer timeouts give consumers more time to process messages in between
+ heartbeats at the cost of a longer time to detect failures.
+ type: integer
+ example: 1800000
+ minimum: 0
+ maximum: 1800000
+ connections_max_idle_ms:
+ description: >-
+ Idle connections timeout: the server socket processor
+ threads close the connections that idle for longer than this.
+ type: integer
+ minimum: 1000
+ example: 540000
+ maximum: 3600000
+ max_incremental_fetch_session_cache_slots:
+ description: >-
+ The maximum number of incremental fetch sessions that the
+ broker will maintain.
+ type: integer
+ example: 1000
+ minimum: 1000
+ maximum: 10000
+ message_max_bytes:
+ description: >-
+ The maximum size of message that the server can receive.
+ type: integer
+ example: 1048588
+ minimum: 0
+ maximum: 100001200
+ offsets_retention_minutes:
+ description: >-
+ Log retention window in minutes for offsets topic
+ type: integer
+ example: 10080
+ minimum: 1
+ maximum: 2147483647
+ log_cleaner_delete_retention_ms:
+ description: >-
+ How long are delete records retained?
+ type: integer
+ minimum: 0
+ maximum: 315569260000
+ example: 86400000
+ log_cleaner_min_cleanable_ratio:
+ description: >-
+ Controls log compactor frequency. Larger value means more
+ frequent compactions but also more space wasted for logs. Consider
+ setting log_cleaner_max_compaction_lag_ms to enforce compactions sooner,
+ instead of setting a very high value for this option.
+ type: number
+ minimum: 0.2
+ maximum: 0.9
+ example: 0.5
+ log_cleaner_max_compaction_lag_ms:
+ description: >-
+ The maximum amount of time message will remain uncompacted.
+ Only applicable for logs that are being compacted
+ type: integer
+ minimum: 30000
+ maximum: 9223372036854776000
+ example: 60000
+ log_cleaner_min_compaction_lag_ms:
+ description: >-
+ The minimum time a message will remain uncompacted in the
+ log. Only applicable for logs that are being compacted.
+ type: integer
+ minimum: 0
+ maximum: 9223372036854776000
+ example: 100000
+ log_cleanup_policy:
+ description: >-
+ The default cleanup policy for segments beyond the retention
+ window
+ type: string
+ enum:
+ - delete
+ - compact
+ - compact,delete
+ example: delete
+ log_flush_interval_messages:
+ description: >-
+ The number of messages accumulated on a log partition before
+ messages are flushed to disk
+ type: integer
+ minimum: 1
+ maximum: 9223372036854776000
+ example: 9223372036854776000
+ log_flush_interval_ms:
+ description: >-
+ The maximum time in ms that a message in any topic is kept
+ in memory before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms
+ is used
+ type: integer
+ minimum: 0
+ maximum: 9223372036854776000
+ example: 1000000
+ log_index_interval_bytes:
+ description: >-
+ The interval with which Kafka adds an entry to the offset
+ index
+ type: integer
+ minimum: 0
+ maximum: 104857600
+ example: 4096
+ log_index_size_max_bytes:
+ description: >-
+ The maximum size in bytes of the offset index
+ type: integer
+ minimum: 1048576
+ maximum: 104857600
+ example: 10485760
+ log_message_downconversion_enable:
+ description: >-
+ This configuration controls whether down-conversion of
+ message formats is enabled to satisfy consume requests.
+ type: boolean
+ example: true
+ log_message_timestamp_type:
+ description: >-
+ Define whether the timestamp in the message is message
+ create time or log append time.
+ type: string
+ enum:
+ - CreateTime
+ - LogAppendTime
+ example: CreateTime
+ log_message_timestamp_difference_max_ms:
+ description: >-
+ The maximum difference allowed between the timestamp when
+ a broker receives a message and the timestamp specified in the message
+ type: integer
+ minimum: 0
+ maximum: 9223372036854776000
+ example: 1000000
+ log_preallocate:
+ description: >-
+ Controls whether to preallocate a file when creating a new segment
+ type: boolean
+ example: false
+ log_retention_bytes:
+ description: >-
+ The maximum size of the log before deleting messages
+ type: integer
+ minimum: -1
+ maximum: 9223372036854776000
+ example: 1000000
+ log_retention_hours:
+ description: >-
+ The number of hours to keep a log file before deleting it
+ type: integer
+ minimum: -1
+ maximum: 2147483647
+ example: 1000000
+ log_retention_ms:
+ description: >-
+ The number of milliseconds to keep a log file before deleting
+ it (in milliseconds), If not set, the value in log.retention.minutes
+ is used. If set to -1, no time limit is applied.
+ type: integer
+ minimum: -1
+ maximum: 9223372036854776000
+ example: 100000000
+ log_roll_jitter_ms:
+ description: >-
+ The maximum jitter to subtract from logRollTimeMillis (in
+ milliseconds). If not set, the value in log.roll.jitter.hours is used
+ type: integer
+ minimum: 0
+ maximum: 9223372036854776000
+ example: 10000000
+ log_roll_ms:
+ description: >-
+ The maximum time before a new log segment is rolled out
+ (in milliseconds).
+ type: integer
+ minimum: 1
+ maximum: 9223372036854776000
+ example: 1000000
+ log_segment_bytes:
+ description: >-
+ The maximum size of a single log file
+ type: integer
+ minimum: 10485760
+ maximum: 1073741824
+ example: 100000000
+ log_segment_delete_delay_ms:
+ description: >-
+ The amount of time to wait before deleting a file from
+ the filesystem
+ type: integer
+ minimum: 0
+ maximum: 3600000
+ example: 60000
+ auto_create_topics_enable:
+ description: >-
+ Enable auto creation of topics
+ type: boolean
+ example: true
+ min_insync_replicas:
+ description: >-
+ When a producer sets acks to 'all' (or '-1'), min_insync_replicas
+ specifies the minimum number of replicas that must acknowledge a write
+ for the write to be considered successful.
+ type: integer
+ minimum: 1
+ maximum: 7
+ example: 1
+ num_partitions:
+ description: >-
+ Number of partitions for autocreated topics
+ type: integer
+ minimum: 1
+ maximum: 1000
+ example: 10
+ default_replication_factor:
+ description: >-
+ Replication factor for autocreated topics
+ type: integer
+ minimum: 1
+ maximum: 10
+ example: 2
+ replica_fetch_max_bytes:
+ description: >-
+ The number of bytes of messages to attempt to fetch for
+ each partition (defaults to 1048576). This is not an absolute maximum,
+ if the first record batch in the first non-empty partition of the
+ fetch is larger than this value, the record batch will still be returned
+ to ensure that progress can be made.
+ type: integer
+ minimum: 1048576
+ maximum: 104857600
+ example: 2097152
+ replica_fetch_response_max_bytes:
+ description: >-
+ Maximum bytes expected for the entire fetch response (defaults
+ to 10485760). Records are fetched in batches, and if the first record
+ batch in the first non-empty partition of the fetch is larger than
+ this value, the record batch will still be returned to ensure that
+ progress can be made. As such, this is not an absolute maximum.
+ type: integer
+ minimum: 10485760
+ maximum: 1048576000
+ example: 20971520
+ max_connections_per_ip:
+ description: >-
+ The maximum number of connections allowed from each ip
+ address (defaults to 2147483647).
+ type: integer
+ minimum: 256
+ maximum: 2147483647
+ example: 512
+ producer_purgatory_purge_interval_requests:
+ description: >-
+ The purge interval (in number of requests) of the producer
+ request purgatory (defaults to 1000).
+ type: integer
+ minimum: 10
+ maximum: 10000
+ example: 100
+ socket_request_max_bytes:
+ description: >-
+ The maximum number of bytes in a socket request (defaults
+ to 104857600).
+ type: integer
+ minimum: 10485760
+ maximum: 209715200
+ example: 20971520
+ transaction_state_log_segment_bytes:
+ description: >-
+ The transaction topic segment bytes should be kept relatively
+ small in order to facilitate faster log compaction and cache loads
+ (defaults to 104857600 (100 mebibytes)).
+ type: integer
+ minimum: 1048576
+ maximum: 2147483647
+ example: 104857600
+ transaction_remove_expired_transaction_cleanup_interval_ms:
+ description: >-
+ The interval at which to remove transactions that have
+ expired due to transactional.id.expiration.ms passing (defaults to
+ 3600000 (1 hour)).
+ type: integer
+ minimum: 600000
+ maximum: 3600000
+ example: 3600000
\ No newline at end of file
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/mongo.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/mongo.yml
new file mode 100644
index 000000000..a6ca81d9d
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/mongo.yml
@@ -0,0 +1,52 @@
+type: object
+
+properties:
+ default_read_concern:
+ description: >-
+ Specifies the default consistency behavior of reads from the database. Data that is returned from the query with may
+ or may not have been acknowledged by all nodes in the replicaset depending on this value.
+ Learn more [here](https://www.mongodb.com/docs/manual/reference/read-concern/).
+ type: string
+ enum: [local, available, majority]
+ default: local
+ example: local
+ default_write_concern:
+ description: >-
+ Describes the level of acknowledgment requested from MongoDB for write operations clusters. This field can set to either `majority`
+ or a number `0...n` which will describe the number of nodes that must acknowledge the write operation before it is fully accepted.
+ Setting to `0` will request no acknowledgement of the write operation.
+ Learn more [here](https://www.mongodb.com/docs/manual/reference/write-concern/).
+ type: string
+ default: majority
+ example: majority
+ transaction_lifetime_limit_seconds:
+ description: >-
+ Specifies the lifetime of multi-document transactions. Transactions that exceed this limit are considered expired and will be
+ aborted by a periodic cleanup process. The cleanup process runs every `transactionLifetimeLimitSeconds/2 seconds` or at least
+ once every 60 seconds. *Changing this parameter will lead to a restart of the MongoDB service.*
+ Learn more [here](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds).
+ type: integer
+ minimum: 1
+ default: 60
+ example: 100
+ slow_op_threshold_ms:
+ description: >-
+ Operations that run for longer than this threshold are considered slow which are then recorded to the diagnostic logs.
+ Higher log levels (verbosity) will record all operations regardless of this threshold on the primary node.
+ *Changing this parameter will lead to a restart of the MongoDB service.*
+ Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-operationProfiling.slowOpThresholdMs).
+ type: integer
+ minimum: 0
+ default: 100
+ example: 200
+ verbosity:
+ description: >-
+ The log message verbosity level. The verbosity level determines the amount of Informational and Debug messages MongoDB outputs.
+ 0 includes informational messages while 1...5 increases the level to include debug messages.
+ *Changing this parameter will lead to a restart of the MongoDB service.*
+ Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-systemLog.verbosity).
+ type: integer
+ minimum: 0
+ maximum: 5
+ default: 0
+ example: 3
\ No newline at end of file
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml
new file mode 100644
index 000000000..1f495b803
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml
@@ -0,0 +1,34 @@
+type: object
+
+properties:
+ uri:
+ type: string
+ description: >-
+ This is provided as a convenience and should be able to be constructed by the other attributes.
+ example: opensearch://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require
+ readOnly: true
+ host:
+ type: string
+ description: The FQDN pointing to the opensearch cluster's current primary node.
+ example: backend-do-user-19081923-0.db.ondigitalocean.com
+ readOnly: true
+ port:
+ type: integer
+ description: The port on which the opensearch dashboard is listening.
+ example: 25060
+ readOnly: true
+ user:
+ type: string
+ description: The default user for the opensearch dashboard.
+ example: doadmin
+ readOnly: true
+ password:
+ type: string
+ description: The randomly generated password for the default user.
+ example: wv78n3zpz42xezdk
+ readOnly: true
+ ssl:
+ type: boolean
+ description: A boolean value indicating if the connection should be made over SSL.
+ example: true
+ readOnly: true
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/options.yml
index 32f54b19c..b9b4cef3c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/options.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/options.yml
@@ -6,39 +6,46 @@ properties:
properties:
kafka:
allOf:
- - $ref: './database_region_options.yml'
- - $ref: './database_version_options.yml'
- - $ref: './database_layout_options.yml'
+ - $ref: "./database_region_options.yml"
+ - $ref: "./database_version_options.yml"
+ - $ref: "./database_layout_options.yml"
mongodb:
allOf:
- - $ref: './database_region_options.yml'
- - $ref: './database_version_options.yml'
- - $ref: './database_layout_options.yml'
+ - $ref: "./database_region_options.yml"
+ - $ref: "./database_version_options.yml"
+ - $ref: "./database_layout_options.yml"
pg:
allOf:
- - $ref: './database_region_options.yml'
- - $ref: './database_version_options.yml'
- - $ref: './database_layout_options.yml'
+ - $ref: "./database_region_options.yml"
+ - $ref: "./database_version_options.yml"
+ - $ref: "./database_layout_options.yml"
mysql:
allOf:
- - $ref: './database_region_options.yml'
- - $ref: './database_version_options.yml'
- - $ref: './database_layout_options.yml'
+ - $ref: "./database_region_options.yml"
+ - $ref: "./database_version_options.yml"
+ - $ref: "./database_layout_options.yml"
redis:
allOf:
- - $ref: './database_region_options.yml'
- - $ref: './database_version_options.yml'
- - $ref: './database_layout_options.yml'
+ - $ref: "./database_region_options.yml"
+ - $ref: "./database_version_options.yml"
+ - $ref: "./database_layout_options.yml"
+ opensearch:
+ allOf:
+ - $ref: "./database_region_options.yml"
+ - $ref: "./database_version_options.yml"
+ - $ref: "./database_layout_options.yml"
version_availability:
type: object
properties:
kafka:
- $ref: './database_version_availabilities.yml'
+ $ref: "./database_version_availabilities.yml"
pg:
- $ref: './database_version_availabilities.yml'
+ $ref: "./database_version_availabilities.yml"
mysql:
- $ref: './database_version_availabilities.yml'
+ $ref: "./database_version_availabilities.yml"
redis:
- $ref: './database_version_availabilities.yml'
+ $ref: "./database_version_availabilities.yml"
mongodb:
- $ref: './database_version_availabilities.yml'
\ No newline at end of file
+ $ref: "./database_version_availabilities.yml"
+ opensearch:
+ $ref: "./database_version_availabilities.yml"
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml
index 8a111fce7..6b8e33004 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml
@@ -1,6 +1,12 @@
type: object
properties:
+ pg_allow_replication:
+ type: boolean
+ example: true
+ description: |
+ For Postgres clusters, set to `true` for a user with replication rights.
+ This option is not currently supported for other database engines.
acl:
type: array
items:
@@ -8,7 +14,7 @@ properties:
properties:
id:
type: string
- description: An identifier for the ACL.
+ description: An identifier for the ACL. Will be computed after the ACL is created/updated.
example: "aaa"
topic:
type: string
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_cluster.yml
index cb1f33ec6..9cfb9918c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_cluster.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_cluster.yml
@@ -40,6 +40,22 @@ content:
user: doadmin
password: wv78n3zpz42xezdk
ssl: true
+ standby_connection:
+ uri: postgres://doadmin:wv78n3zpz42xezdk@replica-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require
+ database: ''
+ host: replica-backend-do-user-19081923-0.db.ondigitalocean.com
+ port: 25060
+ user: doadmin
+ password: wv78n3zpz42xezdk
+ ssl: true
+ standby_private_connection:
+ uri: postgres://doadmin:wv78n3zpz42xezdk@private-replica-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require
+ database: ''
+ host: private-replica-backend-do-user-19081923-0.db.ondigitalocean.com
+ port: 25060
+ user: doadmin
+ password: wv78n3zpz42xezdk
+ ssl: true
users:
- name: doadmin
role: primary
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_metrics_auth.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_metrics_auth.yml
new file mode 100644
index 000000000..6be4a1271
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_metrics_auth.yml
@@ -0,0 +1,20 @@
+description: A JSON object with a key of `credentials`.
+
+headers:
+ ratelimit-limit:
+ $ref: '../../../shared/headers.yml#/ratelimit-limit'
+ ratelimit-remaining:
+ $ref: '../../../shared/headers.yml#/ratelimit-remaining'
+ ratelimit-reset:
+ $ref: '../../../shared/headers.yml#/ratelimit-reset'
+
+content:
+ application/json:
+ schema:
+ properties:
+ credentials:
+ $ref: '../models/database_metrics_credentials.yml'
+ example:
+ credentials:
+ basic_auth_username: username
+ basic_auth_password: password
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/events_logs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/events_logs.yml
new file mode 100644
index 000000000..e147a5c57
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/events_logs.yml
@@ -0,0 +1,29 @@
+description: A JSON object with a key of `events`.
+
+headers:
+ ratelimit-limit:
+ $ref: '../../../shared/headers.yml#/ratelimit-limit'
+ ratelimit-remaining:
+ $ref: '../../../shared/headers.yml#/ratelimit-remaining'
+ ratelimit-reset:
+ $ref: '../../../shared/headers.yml#/ratelimit-reset'
+
+content:
+ application/json:
+ schema:
+ properties:
+ events:
+ type: array
+ items:
+ $ref: '../models/events_logs.yml'
+
+ example:
+ events:
+ - id: 'pe8u2huh'
+ cluster_name: 'customer-events'
+ event_type: 'cluster_create'
+ create_time: '2020-10-29T15:57:38Z'
+ - id: 'pe8ufefuh'
+ cluster_name: 'customer-events'
+ event_type: 'cluster_update'
+ create_time: '2023-10-30T15:57:38Z'
\ No newline at end of file
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml
index 723c31808..1aa36f3ac 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml
@@ -365,6 +365,45 @@ content:
- m-16vcpu-128gb
- m-24vcpu-192gb
- m-32vcpu-256gb
+ opensearch:
+ regions:
+ - ams3
+ - blr1
+ - fra1
+ - lon1
+ - nyc1
+ - nyc3
+ - sfo2
+ - sfo3
+ - sgp1
+ - syd1
+ - tor1
+ versions:
+ - '1'
+ - '2'
+ layouts:
+ - num_nodes: 1
+ sizes:
+ - db-s-2vcpu-4gb
+ - db-s-4vcpu-8gb
+ - num_nodes: 3
+ sizes:
+ - db-s-2vcpu-4gb
+ - db-s-4vcpu-8gb
+ - m3-2vcpu-16gb
+ - m3-4vcpu-32gb
+ - num_nodes: 6
+ sizes:
+ - m3-2vcpu-16gb
+ - m3-4vcpu-32gb
+ - num_nodes: 9
+ sizes:
+ - m3-2vcpu-16gb
+ - m3-4vcpu-32gb
+ - num_nodes: 15
+ sizes:
+ - m3-2vcpu-16gb
+ - m3-4vcpu-32gb
version_availability:
kafka:
- end_of_life: '2024-05-13T00:00:00Z'
@@ -387,6 +426,13 @@ content:
- end_of_life: null
end_of_availability: null
version: '8'
+ opensearch:
+ - end_of_life: null
+ end_of_availability: null
+ version: '1'
+ - end_of_life: null
+ end_of_availability: null
+ version: '2'
pg:
- end_of_life: '2024-11-14T00:00:00Z'
end_of_availability: '2024-05-14T00:00:00Z'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/user.yml
index 08c3c38b5..8cb1b07cb 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/user.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/user.yml
@@ -33,6 +33,15 @@ content:
password: wv78n3zpz42xezdk
mysql_settings:
auth_plugin: mysql_native_password
+
+ New User for Postgres with replication rights:
+ value:
+ user:
+ name: app-02
+ role: normal
+ password: wv78n3zpz42xezdk
+ settings:
+ pg_allow_replication: true
Kafka User:
value:
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create.yml
index d8c16681e..342bd3be9 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create.yml
@@ -43,4 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'domain:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create_record.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create_record.yml
index ab7a45c22..c5a7c5aee 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create_record.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create_record.yml
@@ -83,4 +83,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'domain:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete.yml
index 2b0de7360..827518f1e 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete.yml
@@ -38,4 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'domain:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete_record.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete_record.yml
index 1a323f5c0..e350131dc 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete_record.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete_record.yml
@@ -43,4 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'domain:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get.yml
index 23c0994ef..8a373ec9f 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get.yml
@@ -39,5 +39,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'domain:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get_record.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get_record.yml
index 138ed5243..704e18d80 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get_record.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get_record.yml
@@ -39,5 +39,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'domain:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list.yml
index fb2eaf7ca..43d46e02a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list.yml
@@ -37,5 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'domain:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list_records.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list_records.yml
index d127c742d..e83a8b2ff 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list_records.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list_records.yml
@@ -51,5 +51,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'domain:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_patch_record.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_patch_record.yml
index 59f131810..c39821aba 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_patch_record.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_patch_record.yml
@@ -52,4 +52,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'domain:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_update_record.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_update_record.yml
index 35725b92f..935812642 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_update_record.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_update_record.yml
@@ -54,4 +54,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'domain:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_get.yml
index 24da1f457..9005767b7 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_get.yml
@@ -43,5 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'droplet:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_list.yml
index d905a7405..6e71fb6ab 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_list.yml
@@ -45,5 +45,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'droplet:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml
index 061cc3a1d..1f085ebcc 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml
@@ -22,7 +22,7 @@ description: |
| `rebuild` | Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. |
| `rename` | Renames a Droplet. |
| `change_kernel` | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. |
- | `enable_ipv6` | Enables IPv6 for a Droplet. |
+ | `enable_ipv6` | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, [additional OS-level configuration](https://docs.digitalocean.com/products/networking/ipv6/how-to/enable/#on-existing-droplets) is required. |
| `snapshot` | Takes a snapshot of a Droplet. |
tags:
@@ -94,4 +94,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'droplet:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post_byTag.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post_byTag.yml
index fb9c9b40e..49194314c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post_byTag.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post_byTag.yml
@@ -72,4 +72,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'droplet:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_create.yml
index 00693cddb..a8b4aa046 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_create.yml
@@ -70,4 +70,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'droplet:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy.yml
index 7b5fbbfd3..f0057dc92 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy.yml
@@ -41,4 +41,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'droplet:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_byTag.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_byTag.yml
index 684eb78b2..791e7121e 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_byTag.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_byTag.yml
@@ -43,4 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'droplet:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_retryWithAssociatedResources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_retryWithAssociatedResources.yml
index 57e31fa86..9d2bb2ab2 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_retryWithAssociatedResources.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_retryWithAssociatedResources.yml
@@ -46,4 +46,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'droplet:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml
index 848d3732b..d7dd2d335 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml
@@ -46,4 +46,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'droplet:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml
index e8b31fa78..c5c73319a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml
@@ -52,4 +52,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'droplet:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get.yml
index 17bbfd01c..eecb814ed 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get.yml
@@ -39,5 +39,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'droplet:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml
index 9fda4a29d..72b7fdde0 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml
@@ -38,5 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'droplet:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list.yml
index f6d075e8e..5d37ed30c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list.yml
@@ -49,5 +49,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'droplet:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_associatedResources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_associatedResources.yml
index 5294b4373..8419a1cce 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_associatedResources.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_associatedResources.yml
@@ -42,5 +42,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'droplet:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backups.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backups.yml
index ab2379253..536adb04d 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backups.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backups.yml
@@ -45,5 +45,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'droplet:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_firewalls.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_firewalls.yml
index c3177b43b..c8d363aff 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_firewalls.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_firewalls.yml
@@ -39,5 +39,4 @@ responses:
security:
- bearer_auth:
- - 'read'
-
+ - 'firewall:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_kernels.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_kernels.yml
index 61ca30d52..5612acfb5 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_kernels.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_kernels.yml
@@ -45,5 +45,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'droplet:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighbors.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighbors.yml
index 144ce9b8f..873e9da57 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighbors.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighbors.yml
@@ -43,5 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'droplet:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighborsIds.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighborsIds.yml
index 70209670e..77a198a2c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighborsIds.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighborsIds.yml
@@ -40,5 +40,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'droplet:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_snapshots.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_snapshots.yml
index 7cd128692..73e0d9d0c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_snapshots.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_snapshots.yml
@@ -45,5 +45,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'droplet:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_multi_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_multi_create.yml
index c2e8df4bf..dadb0c835 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_multi_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_multi_create.yml
@@ -7,6 +7,8 @@ allOf:
type: array
items:
type: string
+ maxLength: 255
+ pattern: ^[a-zA-Z0-9]?[a-z0-9A-Z.\-]*[a-z0-9A-Z]$
example:
- sub-01.example.com
- sub-02.example.com
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_single_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_single_create.yml
index e2ebd8d42..1fa5b56a1 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_single_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_single_create.yml
@@ -5,6 +5,8 @@ allOf:
properties:
name:
type: string
+ maxLength: 255
+ pattern: ^[a-zA-Z0-9]?[a-z0-9A-Z.\-]*[a-z0-9A-Z]$
example: example.com
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
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_rules.yml
index 7a3cba5e9..11de54796 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_rules.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_rules.yml
@@ -76,4 +76,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'firewall:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_tags.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_tags.yml
index d4eceeeda..712535d2c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_tags.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_tags.yml
@@ -66,4 +66,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'firewall:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_assign_droplets.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_assign_droplets.yml
index 6a41c0703..14f80c1fe 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_assign_droplets.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_assign_droplets.yml
@@ -69,4 +69,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'firewall:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_create.yml
index 0b5c4d548..e2f38f943 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_create.yml
@@ -77,4 +77,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'firewall:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete.yml
index 72248b471..a52f0b2de 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete.yml
@@ -42,4 +42,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'firewall:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_droplets.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_droplets.yml
index 30d854d38..5b8110532 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_droplets.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_droplets.yml
@@ -69,4 +69,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'firewall:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_rules.yml
index 95b485e9f..fd56b2a39 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_rules.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_rules.yml
@@ -76,4 +76,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'firewall:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_tags.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_tags.yml
index 6d1b37c4a..4282d92f7 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_tags.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_tags.yml
@@ -66,4 +66,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'firewall:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_get.yml
index c3aea7ef8..2b80b1908 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_get.yml
@@ -39,5 +39,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'firewall:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_list.yml
index 6c89ad437..2832290b1 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_list.yml
@@ -37,5 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'firewall:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_update.yml
index 300dc25cc..b870374be 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_update.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_update.yml
@@ -87,4 +87,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'firewall:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_get.yml
index 416ff667d..70e0a9db1 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_get.yml
@@ -38,5 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'firewall:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_list.yml
index 501f835ae..a3ef73cb3 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_list.yml
@@ -37,5 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'firewall:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_post.yml
index e3a6f0364..829a591b8 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_post.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_post.yml
@@ -61,4 +61,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'reserved_ip:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_create.yml
index 0fb83dd3f..e4ad6626f 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_create.yml
@@ -49,4 +49,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'reserved_ip:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_delete.yml
index 4d739ef17..34db51088 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_delete.yml
@@ -41,4 +41,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'reserved_ip:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_get.yml
index 1659f2cac..4a724e78a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_get.yml
@@ -37,5 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'firewall:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_list.yml
index 124a36b04..109148593 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_list.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'firewall:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_namespace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_namespace.yml
index c9e3be35e..70539e262 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_namespace.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_namespace.yml
@@ -44,4 +44,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'function:create'
+ - 'function:admin'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_trigger.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_trigger.yml
index f53b1bc1e..e7c39b632 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_trigger.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_trigger.yml
@@ -49,4 +49,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'function:create'
+ - 'function:admin'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_namespace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_namespace.yml
index 09b37a2b3..dd978920f 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_namespace.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_namespace.yml
@@ -42,4 +42,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'function:delete'
+ - 'function:admin'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_trigger.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_trigger.yml
index fd52fa0b1..18b99b043 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_trigger.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_trigger.yml
@@ -41,4 +41,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'function:delete'
+ - 'function:admin'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_namespace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_namespace.yml
index 480d89a8a..823ee73c5 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_namespace.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_namespace.yml
@@ -40,4 +40,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'function:admin'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_trigger.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_trigger.yml
index b06555217..f8d957eeb 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_trigger.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_trigger.yml
@@ -38,4 +38,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'function:read'
+ - 'function:admin'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_namespaces.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_namespaces.yml
index 5266a0c00..768564658 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_namespaces.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_namespaces.yml
@@ -31,4 +31,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'function:read'
+ - 'function:admin'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_triggers.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_triggers.yml
index 55f1ea1d0..b32e00f71 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_triggers.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_triggers.yml
@@ -37,4 +37,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'function:read'
+ - 'function:admin'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_update_trigger.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_update_trigger.yml
index 6a6f2b88a..4eec732af 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_update_trigger.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_update_trigger.yml
@@ -47,4 +47,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'function:update'
+ - 'function:admin'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_get.yml
index f0dee7f21..e1e3b9b43 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_get.yml
@@ -40,5 +40,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'image:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_list.yml
index b6ebe4fb2..eb72a3629 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_list.yml
@@ -38,5 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'image:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_post.yml
index 246782864..aa2f29241 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_post.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_post.yml
@@ -63,4 +63,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'image:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_create_custom.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_create_custom.yml
index 6a09216ce..8edb6ba61 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_create_custom.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_create_custom.yml
@@ -43,4 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'image:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_delete.yml
index fe9d8ca2d..506992e44 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_delete.yml
@@ -38,4 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'image:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_get.yml
index 7b14138f0..08b1e0e61 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_get.yml
@@ -59,5 +59,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'image:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_list.yml
index ccc7930d1..7e4c0b157 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_list.yml
@@ -62,5 +62,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'image:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_update.yml
index e38b8d705..e5c020d55 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_update.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_update.yml
@@ -48,4 +48,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'image:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_nodePool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_nodePool.yml
index 28da92d22..4096c37a2 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_nodePool.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_nodePool.yml
@@ -58,4 +58,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registry.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registry.yml
index 9c204d65d..67ac1e15e 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registry.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registry.yml
@@ -37,4 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_create_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_create_cluster.yml
index 1943c7879..f5bc62c11 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_create_cluster.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_create_cluster.yml
@@ -54,4 +54,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_cluster.yml
index 8ca28acdf..a1cf035fb 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_cluster.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_cluster.yml
@@ -42,4 +42,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_node.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_node.yml
index b4073d953..b6cd32b72 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_node.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_node.yml
@@ -50,4 +50,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_nodePool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_nodePool.yml
index 7c69a55d0..70c323fc6 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_nodePool.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_nodePool.yml
@@ -43,4 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesDangerous.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesDangerous.yml
index 5e3539a19..9623b592c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesDangerous.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesDangerous.yml
@@ -39,4 +39,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesSelective.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesSelective.yml
index 3a564a66e..49ee4c649 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesSelective.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesSelective.yml
@@ -54,4 +54,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_availableUpgrades.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_availableUpgrades.yml
index 9d75d1e38..894be9741 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_availableUpgrades.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_availableUpgrades.yml
@@ -39,5 +39,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'kubernetes:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_cluster.yml
index b6f619df6..0c90be8c8 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_cluster.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_cluster.yml
@@ -39,5 +39,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'kubernetes:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterLintResults.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterLintResults.yml
index 2fc7a565c..1ab37cd19 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterLintResults.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterLintResults.yml
@@ -43,5 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'kubernetes:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterUser.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterUser.yml
index 616dd7279..2848f3a71 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterUser.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterUser.yml
@@ -37,5 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'kubernetes:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml
index 09458f36c..23faf9bfd 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml
@@ -54,4 +54,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:access_cluster'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_kubeconfig.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_kubeconfig.yml
index ef897dc2b..e2c6f374a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_kubeconfig.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_kubeconfig.yml
@@ -55,4 +55,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:access_cluster'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_nodePool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_nodePool.yml
index 4a847ca55..d4759a377 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_nodePool.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_nodePool.yml
@@ -40,5 +40,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'kubernetes:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_associatedResources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_associatedResources.yml
index 74c5e6573..42951f192 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_associatedResources.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_associatedResources.yml
@@ -40,5 +40,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'kubernetes:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_clusters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_clusters.yml
index dfddf129d..bc6662b2c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_clusters.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_clusters.yml
@@ -37,5 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'kubernetes:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_nodePools.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_nodePools.yml
index a917c92ee..4e6898853 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_nodePools.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_nodePools.yml
@@ -39,5 +39,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'kubernetes:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_options.yml
index 305424118..71bfb1318 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_options.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_options.yml
@@ -36,5 +36,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'kubernetes:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_recycle_nodePool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_recycle_nodePool.yml
index 28a130858..2e57cc734 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_recycle_nodePool.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_recycle_nodePool.yml
@@ -50,4 +50,4 @@ responses:
$ref: '../../shared/responses/unexpected_error.yml'
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registry.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registry.yml
index 1de09cccc..15b9fc34b 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registry.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registry.yml
@@ -37,4 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_run_clusterLint.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_run_clusterLint.yml
index d9c87dc44..b0b726264 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_run_clusterLint.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_run_clusterLint.yml
@@ -52,5 +52,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'kubernetes:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_cluster.yml
index c162cdd37..a76805cdc 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_cluster.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_cluster.yml
@@ -48,4 +48,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_nodePool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_nodePool.yml
index b2d9bd160..e378ec43c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_nodePool.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_nodePool.yml
@@ -50,4 +50,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_upgrade_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_upgrade_cluster.yml
index 887e41512..34f7b4ea5 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_upgrade_cluster.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_upgrade_cluster.yml
@@ -55,4 +55,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'kubernetes:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_droplets.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_droplets.yml
index f13a8583e..64fd3000f 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_droplets.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_droplets.yml
@@ -58,4 +58,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'load_balancer:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_forwardingRules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_forwardingRules.yml
index 7fa4cfec5..b42dc6ddb 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_forwardingRules.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_forwardingRules.yml
@@ -60,4 +60,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'load_balancer:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_create.yml
index b12b1c848..6867dace8 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_create.yml
@@ -61,4 +61,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'load_balancer:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_delete.yml
index e40295ba6..621815e61 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_delete.yml
@@ -43,4 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'load_balancer:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_get.yml
index 32039372f..9dd294263 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_get.yml
@@ -39,5 +39,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'load_balancer:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_list.yml
index 83c51b8a3..a9f0ad4cd 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_list.yml
@@ -37,5 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'load_balancer:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_droplets.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_droplets.yml
index 9e2c563ec..bcd143a28 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_droplets.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_droplets.yml
@@ -55,4 +55,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'load_balancer:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_forwardingRules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_forwardingRules.yml
index 3d48c6acb..a948f9a93 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_forwardingRules.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_forwardingRules.yml
@@ -60,4 +60,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'load_balancer:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_update.yml
index 8d5c78113..28295043f 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_update.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_update.yml
@@ -55,4 +55,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'load_balancer:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml
index 52b8cc5d2..367259a2a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml
@@ -69,4 +69,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'monitoring:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_alertPolicy.yml
index 50f5764df..ae8d185ff 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_alertPolicy.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_alertPolicy.yml
@@ -34,4 +34,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'monitoring:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_DropletCpuMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_DropletCpuMetrics.yml
index ca19d8bb2..97192203d 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_DropletCpuMetrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_DropletCpuMetrics.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_alertPolicy.yml
index 740a70733..71cc273f1 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_alertPolicy.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_alertPolicy.yml
@@ -34,5 +34,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml
index 3ab45648c..fcafb53fb 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml
index 2d66b0c11..6afa4d65a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appRestartCountMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appRestartCountMetrics.yml
index 3057fbf09..6ed2cdc89 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appRestartCountMetrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appRestartCountMetrics.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletBandwidthMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletBandwidthMetrics.yml
index e68c81cfe..5669f6f04 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletBandwidthMetrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletBandwidthMetrics.yml
@@ -8,6 +8,8 @@ description: >-
to specify if the results should be for the `private` or `public` interface.
Use the `direction` query parameter to specify if the results should be for
`inbound` or `outbound` traffic.
+
+ The metrics in the response body are in megabits per second (Mbps).
tags:
- Monitoring
@@ -41,5 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemFreeMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemFreeMetrics.yml
index 6a02e4581..1a23003e3 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemFreeMetrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemFreeMetrics.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemSizeMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemSizeMetrics.yml
index 427e5c655..7ffe74e07 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemSizeMetrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemSizeMetrics.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad15Metrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad15Metrics.yml
index aefe48fde..62866b907 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad15Metrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad15Metrics.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad1Metrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad1Metrics.yml
index 4dc8e88f5..fca3fa4c6 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad1Metrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad1Metrics.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad5Metrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad5Metrics.yml
index 82f817bbd..0f7a5c4df 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad5Metrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad5Metrics.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryAvailableMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryAvailableMetrics.yml
index cd2f56239..c2a51a24f 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryAvailableMetrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryAvailableMetrics.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryCachedMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryCachedMetrics.yml
index 44d7a84f4..b95eaf193 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryCachedMetrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryCachedMetrics.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryFreeMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryFreeMetrics.yml
index 8b7d07b50..f20553fe9 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryFreeMetrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryFreeMetrics.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryTotalMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryTotalMetrics.yml
index 8623e31dd..b3dd063ed 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryTotalMetrics.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryTotalMetrics.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_alertPolicy.yml
index 52fdeeb68..35926639b 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_alertPolicy.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_alertPolicy.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'monitoring:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml
index 0d6641a0a..0bf239d38 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml
@@ -74,4 +74,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'monitoring:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml
index ea94bd258..6c5599e1b 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml
@@ -50,7 +50,7 @@ network_direction:
metric_timestamp_start:
in: query
name: start
- description: Timestamp to start metric window.
+ description: UNIX timestamp to start metric window.
example: "1620683817"
required: true
schema:
@@ -59,7 +59,7 @@ metric_timestamp_start:
metric_timestamp_end:
in: query
name: end
- description: Timestamp to end metric window.
+ description: UNIX timestamp to end metric window.
example: "1620705417"
required: true
schema:
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources.yml
index 020003ee0..32c815292 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources.yml
@@ -53,4 +53,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'project:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources_default.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources_default.yml
index 162546435..ee556a8f3 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources_default.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources_default.yml
@@ -50,4 +50,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'project:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_create.yml
index f4796fd7e..8dc57bcbe 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_create.yml
@@ -45,4 +45,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'project:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_delete.yml
index 24a2995f7..3f4344d97 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_delete.yml
@@ -46,4 +46,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'project:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get.yml
index 4e53052a4..728d7d8de 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get.yml
@@ -37,5 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'project:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get_default.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get_default.yml
index 179da3ce3..dae4e3d24 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get_default.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get_default.yml
@@ -34,5 +34,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'project:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list.yml
index f5906627e..b09b5623c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'project:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources.yml
index dcfefefe5..8a988617a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources.yml
@@ -40,5 +40,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'project:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources_default.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources_default.yml
index 73a0daea5..7fc823f5c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources_default.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources_default.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'project:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch.yml
index d88ada8d4..047dc4453 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch.yml
@@ -50,4 +50,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'project:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch_default.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch_default.yml
index 6678bfa04..8d8da40be 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch_default.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch_default.yml
@@ -47,4 +47,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'project:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update.yml
index 2f49f5628..18044e8ad 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update.yml
@@ -54,4 +54,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'project:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update_default.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update_default.yml
index bab9b0d38..1a099746f 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update_default.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update_default.yml
@@ -51,4 +51,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'project:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/regions/regions_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/regions/regions_list.yml
index b2ab1f9c2..5f8fb1086 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/regions/regions_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/regions/regions_list.yml
@@ -41,5 +41,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'regions:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_create.yml
index 273679875..f7477b8cb 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_create.yml
@@ -42,4 +42,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'registry:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete.yml
index 27422667a..fc28fe2ec 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete.yml
@@ -33,4 +33,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'registry:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryManifest.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryManifest.yml
index 4c3a06660..d6078ead8 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryManifest.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryManifest.yml
@@ -47,4 +47,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'registry:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryTag.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryTag.yml
index ab591d2b0..3fbf68156 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryTag.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryTag.yml
@@ -47,4 +47,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'registry:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get.yml
index f690d8ab2..412da9e94 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get.yml
@@ -30,5 +30,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'registry:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml
index bba897df0..bbcd750e0 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml
@@ -55,5 +55,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'registry:read'
+ - 'registry:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_garbageCollection.yml
index b281a3eca..fce654c18 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_garbageCollection.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_garbageCollection.yml
@@ -36,4 +36,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'registry:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_options.yml
index d3df86351..306b82146 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_options.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_options.yml
@@ -41,5 +41,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'registry:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_subscription.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_subscription.yml
index 8ffe04586..c0ecae454 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_subscription.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_subscription.yml
@@ -31,5 +31,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'registry:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_garbageCollections.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_garbageCollections.yml
index 20f24fa5e..69ffe66fb 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_garbageCollections.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_garbageCollections.yml
@@ -38,4 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'registry:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositories.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositories.yml
index e2aac1954..f47013883 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositories.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositories.yml
@@ -44,5 +44,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'registry:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoriesV2.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoriesV2.yml
index f40c3878e..81ebb19b7 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoriesV2.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoriesV2.yml
@@ -43,5 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'registry:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryManifests.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryManifests.yml
index 3bd76fa79..909a50b83 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryManifests.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryManifests.yml
@@ -45,5 +45,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'registry:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryTags.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryTags.yml
index 6ca5ea2f2..70d0276ff 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryTags.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryTags.yml
@@ -45,5 +45,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'registry:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_run_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_run_garbageCollection.yml
index 10d81207c..57c8c0a64 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_run_garbageCollection.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_run_garbageCollection.yml
@@ -56,4 +56,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'registry:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_garbageCollection.yml
index e942e6254..9de2dcd5e 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_garbageCollection.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_garbageCollection.yml
@@ -46,4 +46,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'registry:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_subscription.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_subscription.yml
index 3260cb35e..66f902247 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_subscription.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_subscription.yml
@@ -46,4 +46,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'registry:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_validate_name.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_validate_name.yml
index 5e28e03e1..1384aef0c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_validate_name.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_validate_name.yml
@@ -46,4 +46,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'registry:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_get.yml
index caf0b14a0..101d38ac4 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_get.yml
@@ -39,5 +39,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'reserved_ip:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_list.yml
index 13afa0a72..dcb0f722d 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_list.yml
@@ -38,5 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'reserved_ip:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_post.yml
index 4fdf52097..fbc267a6c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_post.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_post.yml
@@ -62,4 +62,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'reserved_ip:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_create.yml
index 4159156c4..548bfe372 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_create.yml
@@ -50,4 +50,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'reserved_ip:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_delete.yml
index 0af22624a..a1a116506 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_delete.yml
@@ -42,4 +42,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'reserved_ip:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_get.yml
index a78b27bca..211bc5d8c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_get.yml
@@ -38,5 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'reserved_ip:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_list.yml
index 78f012b1b..b0a04a25e 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_list.yml
@@ -36,5 +36,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'reserved_ip:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/sizes_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/sizes_list.yml
index 79639c0a1..9f03e4043 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/sizes_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/sizes_list.yml
@@ -40,4 +40,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'sizes:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/responses/not_a_snapshot.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/responses/not_a_snapshot.yml
new file mode 100644
index 000000000..c4434e00b
--- /dev/null
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/responses/not_a_snapshot.yml
@@ -0,0 +1,18 @@
+description: Bad Request
+
+headers:
+ ratelimit-limit:
+ $ref: '../../../shared/headers.yml#/ratelimit-limit'
+ ratelimit-remaining:
+ $ref: '../../../shared/headers.yml#/ratelimit-remaining'
+ ratelimit-reset:
+ $ref: '../../../shared/headers.yml#/ratelimit-reset'
+
+content:
+ application/json:
+ schema:
+ $ref: '../../../shared/models/error.yml'
+ example:
+ id: bad_request
+ message: the resource is not a snapshot
+ request_id: bbd8d7d4-2beb-4be1-a374-338e6165e32d
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_delete.yml
index af56c5a4f..318500321 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_delete.yml
@@ -20,6 +20,9 @@ responses:
'204':
$ref: '../../shared/responses/no_content.yml'
+ '400':
+ $ref: 'responses/not_a_snapshot.yml'
+
'401':
$ref: '../../shared/responses/unauthorized.yml'
@@ -43,4 +46,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'image:delete'
+ - 'snapshot:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_get.yml
index 90eb501f8..2655860e0 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_get.yml
@@ -19,6 +19,9 @@ responses:
'200':
$ref: 'responses/snapshots_existing.yml'
+ '400':
+ $ref: 'responses/not_a_snapshot.yml'
+
'401':
$ref: '../../shared/responses/unauthorized.yml'
@@ -42,5 +45,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'image:read'
+ - 'snapshot:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_list.yml
index da0fae421..f343466c0 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_list.yml
@@ -56,5 +56,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'image:read'
+ - 'snapshot:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_create.yml
index f9fe4cd63..8d1cafd35 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_create.yml
@@ -42,4 +42,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'ssh_key:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_delete.yml
index 5510a6864..de01d8f12 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_delete.yml
@@ -42,4 +42,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'ssh_key:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_get.yml
index 447e91ee1..dfa87f63a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_get.yml
@@ -42,5 +42,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'ssh_key:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_list.yml
index 394a1ad9f..713878e06 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_list.yml
@@ -39,5 +39,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'ssh_key:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_update.yml
index c692038f1..7264e86bd 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_update.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_update.yml
@@ -53,4 +53,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'ssh_key:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_assign_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_assign_resources.yml
index f5a25694b..9e2218149 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_assign_resources.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_assign_resources.yml
@@ -52,4 +52,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'tag:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_create.yml
index c35d1bff4..0b1a9153a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_create.yml
@@ -43,4 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'tag:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_delete.yml
index 5ba6d6c08..3812ebf99 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_delete.yml
@@ -40,4 +40,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'tag:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_get.yml
index 1698b8fbf..22939e128 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_get.yml
@@ -39,5 +39,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'tag:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_list.yml
index 4a84e1221..2b232e6a8 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_list.yml
@@ -35,5 +35,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'tag:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_unassign_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_unassign_resources.yml
index 349ae56d9..999110e0c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_unassign_resources.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_unassign_resources.yml
@@ -52,4 +52,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'tag:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_alert.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_alert.yml
index eda030222..dba2ccb7b 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_alert.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_alert.yml
@@ -63,5 +63,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
-
+ - 'uptime:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_check.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_check.yml
index aa26239d2..326312f7a 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_check.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_check.yml
@@ -49,4 +49,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'uptime:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_alert.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_alert.yml
index ff8ec1d2f..c3f3d63e4 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_alert.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_alert.yml
@@ -40,4 +40,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'uptime:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_check.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_check.yml
index 414a7fb17..7f0a392c2 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_check.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_check.yml
@@ -40,4 +40,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'uptime:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_alert.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_alert.yml
index 1b02ca5da..4bbb6576c 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_alert.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_alert.yml
@@ -38,4 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'uptime:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check.yml
index 2c9ece358..767756671 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check.yml
@@ -36,4 +36,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'uptime:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check_state.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check_state.yml
index e222f3d0e..93def8174 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check_state.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check_state.yml
@@ -37,4 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'uptime:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_alerts.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_alerts.yml
index 9497eaa41..ce423eb38 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_alerts.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_alerts.yml
@@ -38,4 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'uptime:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_checks.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_checks.yml
index efe2e0f32..006519982 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_checks.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_checks.yml
@@ -38,4 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'uptime:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_alert.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_alert.yml
index 1dc7c7ab0..5dca2675d 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_alert.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_alert.yml
@@ -53,4 +53,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'uptime:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_check.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_check.yml
index 2af3a29a0..47422a9e5 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_check.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_check.yml
@@ -46,4 +46,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'uptime:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_get.yml
index 6e901204c..911fa6b9e 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_get.yml
@@ -42,5 +42,5 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
+ - 'block_storage_action:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_list.yml
index 0d405f3e3..542ebc7f7 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_list.yml
@@ -41,5 +41,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'block_storage_action:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml
index 0419f0fe5..ee2774fd8 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml
@@ -96,4 +96,4 @@ x-codeSamples:
security:
- bearer_auth:
- - "write"
+ - "block_storage_action:create"
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml
index de0ff0eda..f3b1a7094 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml
@@ -113,4 +113,4 @@ x-codeSamples:
security:
- bearer_auth:
- - "write"
+ - "block_storage_action:create"
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_create.yml
index b940f9f08..d831f1ae6 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_create.yml
@@ -61,4 +61,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'block_storage_snapshot:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_delete_byId.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_delete_byId.yml
index 52c6873de..171aed129 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_delete_byId.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_delete_byId.yml
@@ -4,7 +4,7 @@ summary: Delete a Volume Snapshot
description: |
To delete a volume snapshot, send a DELETE request to
- `/v2/snapshots/$SNAPSHOT_ID`.
+ `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`.
A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
@@ -13,7 +13,7 @@ tags:
- Block Storage
parameters:
- - $ref: '../snapshots/parameters.yml#/snapshot_id'
+ - $ref: 'parameters.yml#/volume_snapshot_id'
responses:
'204':
@@ -42,4 +42,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'block_storage_snapshot:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_get_byId.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_get_byId.yml
index 350cc4062..fb7a18ef1 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_get_byId.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_get_byId.yml
@@ -4,13 +4,13 @@ summary: Retrieve an Existing Volume Snapshot
description: >+
To retrieve the details of a snapshot that has been created from a volume,
- send a GET request to `/v2/volumes/snapshots/$SNAPSHOT_ID`.
+ send a GET request to `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`.
tags:
- Block Storage
parameters:
- - $ref: "../snapshots/parameters.yml#/snapshot_id"
+ - $ref: 'parameters.yml#/volume_snapshot_id'
responses:
"200":
@@ -37,4 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - "read"
+ - "block_storage_snapshot:read"
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_list.yml
index f7e979753..b0ce65ee7 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_list.yml
@@ -41,5 +41,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'block_storage_snapshot:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_create.yml
index 88fdd1e01..ab84abe95 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_create.yml
@@ -81,4 +81,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'block_storage:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete.yml
index 2ebad04c8..c3f0cc3a3 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete.yml
@@ -43,4 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'block_storage:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete_byName.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete_byName.yml
index eaea80d73..b7d667491 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete_byName.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete_byName.yml
@@ -43,4 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'block_storage:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_get.yml
index 0fa65f65a..e22b5a523 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_get.yml
@@ -39,5 +39,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'block_storage:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_list.yml
index 9985b7292..ae268d365 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_list.yml
@@ -63,4 +63,4 @@ x-codeSamples:
security:
- bearer_auth:
- - "read"
+ - "block_storage:read"
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_create.yml
index eb56c7668..5bdfdd47e 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_create.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_create.yml
@@ -51,4 +51,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'vpc:create'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_delete.yml
index c2f4300d0..850a2a9af 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_delete.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_delete.yml
@@ -43,4 +43,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'vpc:delete'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_get.yml
index 3f7d7fda5..59aad0cc2 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_get.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_get.yml
@@ -37,5 +37,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'vpc:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list.yml
index 0b69fa7e3..446de6981 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list.yml
@@ -38,5 +38,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'vpc:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_members.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_members.yml
index b0e5002bb..2b0915b79 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_members.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_members.yml
@@ -44,5 +44,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'read'
-
+ - 'vpc:read'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_patch.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_patch.yml
index e8b17d2d9..5b48cbcdf 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_patch.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_patch.yml
@@ -48,4 +48,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'vpc:update'
diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_update.yml
index 20cea7d36..3bd002e52 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_update.yml
+++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_update.yml
@@ -51,4 +51,4 @@ x-codeSamples:
security:
- bearer_auth:
- - 'write'
+ - 'vpc:update'
diff --git a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts
index b8d13cc62..b3d4505ef 100644
--- a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts
+++ b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts
@@ -231,9 +231,9 @@ export type paths = {
};
/**
* List installations for the authenticated app
- * @description 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.
+ * @description The permissions the installation has are included under the `permissions` key.
*
- * The permissions the installation has are included under the `permissions` key.
+ * 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.
*/
readonly get: operations["apps/list-installations"];
readonly put?: never;
@@ -283,7 +283,13 @@ export type paths = {
readonly put?: never;
/**
* Create an installation access token for an app
- * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.
+ * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.
+ *
+ * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.
+ *
+ * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.
+ *
+ * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.
*
* 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.
*/
@@ -382,7 +388,15 @@ export type paths = {
readonly put?: never;
/**
* Create a scoped access token
- * @description Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`.
+ * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify
+ * which repositories the token can access and which permissions are granted to the
+ * token.
+ *
+ * Invalid tokens will return `404 NOT FOUND`.
+ *
+ * You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)
+ * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App
+ * as the username and password.
*/
readonly post: operations["apps/scope-token"];
readonly delete?: never;
@@ -401,8 +415,6 @@ export type paths = {
/**
* Get an app
* @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).
- *
- * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.
*/
readonly get: operations["apps/get-by-slug"];
readonly put?: never;
@@ -593,6 +605,39 @@ export type paths = {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/enterprises/{enterprise}/copilot/usage": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get a summary of Copilot usage for enterprise members
+ * @description **Note**: This endpoint is in beta and is subject to change.
+ *
+ * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
+ * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,
+ * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.
+ *
+ * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,
+ * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
+ * they must have telemetry enabled in their IDE.
+ *
+ * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage
+ * metrics for the enterprise.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint.
+ */
+ readonly get: operations["copilot/usage-metrics-for-enterprise"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/enterprises/{enterprise}/dependabot/alerts": {
readonly parameters: {
readonly query?: never;
@@ -603,9 +648,12 @@ export type paths = {
/**
* List Dependabot alerts for an enterprise
* @description Lists Dependabot alerts for repositories that are owned by the specified enterprise.
- * To use this endpoint, you must be a member of the enterprise, and you must use an
- * access token with the `repo` scope or `security_events` scope.
+ *
+ * The authenticated user must be a member of the enterprise to use this endpoint.
+ *
* Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, 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)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.
*/
readonly get: operations["dependabot/list-alerts-for-enterprise"];
readonly put?: never;
@@ -626,7 +674,12 @@ export type paths = {
/**
* List secret scanning alerts for an enterprise
* @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.
- * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).
+ *
+ * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).
+ *
+ * The authenticated user must be a member of the enterprise in order to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.
*/
readonly get: operations["secret-scanning/list-alerts-for-enterprise"];
readonly put?: never;
@@ -666,16 +719,18 @@ export type paths = {
};
/**
* Get feeds
- * @description GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:
+ * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
*
* * **Timeline**: The GitHub global public timeline
- * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)
+ * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."
* * **Current user public**: The public timeline for the authenticated user
* * **Current user**: The private timeline for the authenticated user
* * **Current user actor**: The private timeline for activity created by the authenticated user
* * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.
* * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.
*
+ * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
* **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.
*/
readonly get: operations["activity/get-feeds"];
@@ -762,7 +817,15 @@ export type paths = {
readonly path?: never;
readonly cookie?: never;
};
- /** Get a gist */
+ /**
+ * Get a gist
+ * @description Gets a specified gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
readonly get: operations["gists/get"];
readonly put?: never;
readonly post?: never;
@@ -772,8 +835,16 @@ export type paths = {
readonly head?: never;
/**
* Update a gist
- * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
+ * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files
+ * from the previous version of the gist that aren't explicitly changed during an edit
+ * are unchanged.
+ *
* At least one of `description` or `files` is required.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
*/
readonly patch: operations["gists/update"];
readonly trace?: never;
@@ -785,10 +856,26 @@ export type paths = {
readonly path?: never;
readonly cookie?: never;
};
- /** List gist comments */
+ /**
+ * List gist comments
+ * @description Lists the comments on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
readonly get: operations["gists/list-comments"];
readonly put?: never;
- /** Create a gist comment */
+ /**
+ * Create a gist comment
+ * @description Creates a comment on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
readonly post: operations["gists/create-comment"];
readonly delete?: never;
readonly options?: never;
@@ -803,7 +890,15 @@ export type paths = {
readonly path?: never;
readonly cookie?: never;
};
- /** Get a gist comment */
+ /**
+ * Get a gist comment
+ * @description Gets a comment on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
readonly get: operations["gists/get-comment"];
readonly put?: never;
readonly post?: never;
@@ -811,7 +906,15 @@ export type paths = {
readonly delete: operations["gists/delete-comment"];
readonly options?: never;
readonly head?: never;
- /** Update a gist comment */
+ /**
+ * Update a gist comment
+ * @description Updates a comment on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
readonly patch: operations["gists/update-comment"];
readonly trace?: never;
};
@@ -861,7 +964,7 @@ export type paths = {
readonly get: operations["gists/check-is-starred"];
/**
* Star a gist
- * @description Note that 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)."
+ * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
readonly put: operations["gists/star"];
readonly post?: never;
@@ -879,7 +982,15 @@ export type paths = {
readonly path?: never;
readonly cookie?: never;
};
- /** Get a gist revision */
+ /**
+ * Get a gist revision
+ * @description Gets a specified gist revision.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
readonly get: operations["gists/get-revision"];
readonly put?: never;
readonly post?: never;
@@ -918,8 +1029,11 @@ export type paths = {
};
/**
* Get a gitignore template
- * @description The API also allows fetching the source of a single template.
- * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents.
+ * @description Get the content of a gitignore template.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.
*/
readonly get: operations["gitignore/get-template"];
readonly put?: never;
@@ -940,8 +1054,6 @@ export type paths = {
/**
* List repositories accessible to the app installation
* @description List repositories that an app installation can access.
- *
- * 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.
*/
readonly get: operations["apps/list-repos-accessible-to-installation"];
readonly put?: never;
@@ -967,8 +1079,6 @@ export type 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/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.
*/
readonly delete: operations["apps/revoke-installation-access-token"];
readonly options?: never;
@@ -989,11 +1099,17 @@ export type paths = {
* repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not
* necessarily assigned to you.
*
- *
* **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/list"];
readonly put?: never;
@@ -1294,7 +1410,11 @@ export type paths = {
readonly get: operations["activity/get-thread"];
readonly put?: never;
readonly post?: never;
- readonly delete?: never;
+ /**
+ * Mark a thread as done
+ * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.
+ */
+ readonly delete: operations["activity/mark-thread-as-done"];
readonly options?: never;
readonly head?: never;
/**
@@ -1367,7 +1487,7 @@ export type paths = {
};
/**
* List organizations
- * @description Lists all organizations, in the order that they were created on GitHub.
+ * @description Lists all organizations, in the order that they were created.
*
* **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.
*/
@@ -1389,9 +1509,26 @@ export type paths = {
};
/**
* Get an organization
- * @description To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).
+ * @description Gets information about an organization.
+ *
+ * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).
+ *
+ * To see the full details about an organization, the authenticated user must be an organization owner.
+ *
+ * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration:
*
- * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below."
+ * - advanced_security_enabled_for_new_repositories
+ * - dependabot_alerts_enabled_for_new_repositories
+ * - dependabot_security_updates_enabled_for_new_repositories
+ * - dependency_graph_enabled_for_new_repositories
+ * - secret_scanning_enabled_for_new_repositories
+ * - secret_scanning_push_protection_enabled_for_new_repositories
+ *
+ * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.
+ *
+ * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.
*/
readonly get: operations["orgs/get"];
readonly put?: never;
@@ -1413,7 +1550,22 @@ export type paths = {
* Update an organization
* @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).
*
- * Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges.
+ * Updates the organization's profile and member privileges.
+ *
+ * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:
+ *
+ * - advanced_security_enabled_for_new_repositories
+ * - dependabot_alerts_enabled_for_new_repositories
+ * - dependabot_security_updates_enabled_for_new_repositories
+ * - dependency_graph_enabled_for_new_repositories
+ * - secret_scanning_enabled_for_new_repositories
+ * - secret_scanning_push_protection_enabled_for_new_repositories
+ *
+ * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)."
+ *
+ * The authenticated user must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.
*/
readonly patch: operations["orgs/update"];
readonly trace?: never;
@@ -1429,7 +1581,8 @@ export type paths = {
* Get GitHub Actions cache usage for an organization
* @description Gets the total GitHub Actions cache usage for an organization.
* The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
*/
readonly get: operations["actions/get-actions-cache-usage-for-org"];
readonly put?: never;
@@ -1451,7 +1604,8 @@ export type paths = {
* List repositories with GitHub Actions cache usage for an organization
* @description Lists repositories and their GitHub Actions cache usage for an organization.
* The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
*/
readonly get: operations["actions/get-actions-cache-usage-by-repo-for-org"];
readonly put?: never;
@@ -1472,15 +1626,15 @@ export type paths = {
/**
* Get the customization template for an OIDC subject claim for an organization
* @description Gets the customization template for an OpenID Connect (OIDC) subject claim.
- * You must authenticate using an access token with the `read:org` scope to use this endpoint.
- * GitHub Apps must have the `organization_administration:write` permission to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
*/
readonly get: operations["oidc/get-oidc-custom-sub-template-for-org"];
/**
* Set the customization template for an OIDC subject claim for an organization
* @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.
- * You must authenticate using an access token with the `write:org` scope to use this endpoint.
- * GitHub Apps must have the `admin:org` permission to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
*/
readonly put: operations["oidc/update-oidc-custom-sub-template-for-org"];
readonly post?: never;
@@ -1501,14 +1655,14 @@ export type paths = {
* Get GitHub Actions permissions for an organization
* @description Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["actions/get-github-actions-permissions-organization"];
/**
* Set GitHub Actions permissions for an organization
* @description Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["actions/set-github-actions-permissions-organization"];
readonly post?: never;
@@ -1529,14 +1683,15 @@ export type paths = {
* List selected repositories enabled for GitHub Actions in an organization
* @description Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["actions/list-selected-repositories-enabled-github-actions-organization"];
/**
* Set selected repositories enabled for GitHub Actions in an organization
* @description Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["actions/set-selected-repositories-enabled-github-actions-organization"];
readonly post?: never;
@@ -1558,7 +1713,7 @@ export type paths = {
* Enable a selected repository for GitHub Actions in an organization
* @description Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["actions/enable-selected-repository-github-actions-organization"];
readonly post?: never;
@@ -1566,7 +1721,7 @@ export type paths = {
* Disable a selected repository for GitHub Actions in an organization
* @description Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["actions/disable-selected-repository-github-actions-organization"];
readonly options?: never;
@@ -1583,16 +1738,16 @@ export type paths = {
};
/**
* Get allowed actions and reusable workflows for an organization
- * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).""
+ * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["actions/get-allowed-actions-organization"];
/**
* Set allowed actions and reusable workflows for an organization
* @description Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["actions/set-allowed-actions-organization"];
readonly post?: never;
@@ -1615,7 +1770,7 @@ export type paths = {
* as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
* "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["actions/get-github-actions-default-workflow-permissions-organization"];
/**
@@ -1624,7 +1779,7 @@ export type paths = {
* can submit approving pull request reviews. For more information, see
* "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["actions/set-github-actions-default-workflow-permissions-organization"];
readonly post?: never;
@@ -1645,10 +1800,9 @@ export type paths = {
* List self-hosted runners for an organization
* @description Lists all self-hosted runners configured in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-self-hosted-runners-for-org"];
readonly put?: never;
@@ -1670,10 +1824,9 @@ export type paths = {
* List runner applications for an organization
* @description Lists binaries for the runner application that you can download and run.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-runner-applications-for-org"];
readonly put?: never;
@@ -1697,10 +1850,9 @@ export type paths = {
* Create configuration for a just-in-time runner for an organization
* @description Generates a configuration that can be passed to the runner application at startup.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * The authenticated user must have admin access to the organization.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/generate-runner-jitconfig-for-org"];
readonly delete?: never;
@@ -1722,18 +1874,15 @@ export type paths = {
* Create a registration token for an organization
* @description Returns a token that you can pass to the `config` script. The token expires after one hour.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
- *
- * Example using registration token:
- *
- * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
*
* ```
* ./config.sh --url https://github.com/octo-org --token TOKEN
* ```
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-registration-token-for-org"];
readonly delete?: never;
@@ -1755,19 +1904,15 @@ export type paths = {
* Create a remove token for an organization
* @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
- *
- * Example using remove token:
- *
- * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this
- * endpoint.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:
*
* ```
* ./config.sh remove --token TOKEN
* ```
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-remove-token-for-org"];
readonly delete?: never;
@@ -1787,10 +1932,9 @@ export type paths = {
* Get a self-hosted runner for an organization
* @description Gets a specific self-hosted runner configured in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/get-self-hosted-runner-for-org"];
readonly put?: never;
@@ -1799,10 +1943,9 @@ export type paths = {
* Delete a self-hosted runner from an organization
* @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-self-hosted-runner-from-org"];
readonly options?: never;
@@ -1821,10 +1964,9 @@ export type paths = {
* List labels for a self-hosted runner for an organization
* @description Lists all labels for a self-hosted runner configured in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-labels-for-self-hosted-runner-for-org"];
/**
@@ -1832,20 +1974,18 @@ export type paths = {
* @description Remove all previous custom labels and set the new custom labels for a specific
* self-hosted runner configured in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"];
/**
* Add custom labels to a self-hosted runner for an organization
- * @description Add custom labels to a self-hosted runner configured in an organization.
+ * @description Adds custom labels to a self-hosted runner configured in an organization.
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"];
/**
@@ -1853,10 +1993,9 @@ export type paths = {
* @description Remove all custom labels from a self-hosted runner configured in an
* organization. Returns the remaining read-only labels from the runner.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"];
readonly options?: never;
@@ -1882,10 +2021,9 @@ export type paths = {
* This endpoint returns a `404 Not Found` status if the custom label is not
* present on the runner.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"];
readonly options?: never;
@@ -1905,10 +2043,9 @@ export type paths = {
* @description Lists all secrets available in an organization without revealing their
* encrypted values.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-org-secrets"];
readonly put?: never;
@@ -1931,10 +2068,9 @@ export type paths = {
* @description Gets your public key, which you need to encrypt secrets. You need to
* encrypt a secret before you can create or update secrets.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ * The authenticated user must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-org-public-key"];
readonly put?: never;
@@ -1956,10 +2092,9 @@ export type paths = {
* Get an organization secret
* @description Gets a single organization secret without revealing its encrypted value.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ * The authenticated user must have collaborator access to a repository to create, update, or read secrets
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-org-secret"];
/**
@@ -1967,10 +2102,9 @@ export type paths = {
* @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/create-or-update-org-secret"];
readonly post?: never;
@@ -1978,10 +2112,9 @@ export type paths = {
* Delete an organization secret
* @description Deletes a secret in an organization using the secret name.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-org-secret"];
readonly options?: never;
@@ -2001,10 +2134,9 @@ export type paths = {
* @description Lists all repositories that have been selected when the `visibility`
* for repository access to a secret is set to `selected`.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-selected-repos-for-org-secret"];
/**
@@ -2013,10 +2145,9 @@ export type paths = {
* for repository access is set to `selected`. The visibility is set when you [Create
* or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly put: operations["actions/set-selected-repos-for-org-secret"];
readonly post?: never;
@@ -2037,13 +2168,12 @@ export type paths = {
/**
* Add selected repository to an organization secret
* @description Adds a repository to an organization secret when the `visibility` for
- * repository access is set to `selected`. The visibility is set when you [Create or
+ * repository access is set to `selected`. For more information about setting the visibility, see [Create or
* update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/add-selected-repo-to-org-secret"];
readonly post?: never;
@@ -2053,10 +2183,9 @@ export type paths = {
* for repository access is set to `selected`. The visibility is set when you [Create
* or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly delete: operations["actions/remove-selected-repo-from-org-secret"];
readonly options?: never;
@@ -2074,7 +2203,10 @@ export type paths = {
/**
* List organization variables
* @description Lists all organization variables.
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-org-variables"];
readonly put?: never;
@@ -2082,10 +2214,9 @@ export type paths = {
* Create an organization variable
* @description Creates an organization variable that you can reference in a GitHub Actions workflow.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-org-variable"];
readonly delete?: never;
@@ -2105,10 +2236,9 @@ export type paths = {
* Get an organization variable
* @description Gets a specific variable in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ * The authenticated user must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-org-variable"];
readonly put?: never;
@@ -2117,10 +2247,9 @@ export type paths = {
* Delete an organization variable
* @description Deletes an organization variable using the variable name.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-org-variable"];
readonly options?: never;
@@ -2129,10 +2258,9 @@ export type paths = {
* Update an organization variable
* @description Updates an organization variable that you can reference in a GitHub Actions workflow.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly patch: operations["actions/update-org-variable"];
readonly trace?: never;
@@ -2149,10 +2277,9 @@ export type paths = {
* @description Lists all repositories that can access an organization variable
* that is available to selected repositories.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-selected-repos-for-org-variable"];
/**
@@ -2161,11 +2288,9 @@ export type paths = {
* to selected repositories. Organization variables that are available to selected
* repositories have their `visibility` field set to `selected`.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this
- * endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly put: operations["actions/set-selected-repos-for-org-variable"];
readonly post?: never;
@@ -2188,10 +2313,9 @@ export type paths = {
* @description Adds a repository to an organization variable that is available to selected repositories.
* Organization variables that are available to selected repositories have their `visibility` field set to `selected`.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/add-selected-repo-to-org-variable"];
readonly post?: never;
@@ -2201,10 +2325,9 @@ export type paths = {
* available to selected repositories. Organization variables that are available to
* selected repositories have their `visibility` field set to `selected`.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly delete: operations["actions/remove-selected-repo-from-org-variable"];
readonly options?: never;
@@ -2271,9 +2394,9 @@ export type paths = {
* List code scanning alerts for an organization
* @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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)."
*
- * 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 `security_events` scope.
+ * The authenticated user must be an owner or security manager for the organization to use this endpoint.
*
- * For public repositories, you may instead use the `public_repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/list-alerts-for-org"];
readonly put?: never;
@@ -2295,7 +2418,7 @@ export type paths = {
* List codespaces for the organization
* @description Lists the codespaces associated to a specified organization.
*
- * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-in-organization"];
readonly put?: never;
@@ -2318,7 +2441,7 @@ export type paths = {
* Manage access control for organization codespaces
* @deprecated
* @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.
- * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["codespaces/set-codespaces-access"];
readonly post?: never;
@@ -2345,7 +2468,7 @@ export type paths = {
* To use this endpoint, the access settings for the organization must be set to `selected_members`.
* For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."
*
- * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly post: operations["codespaces/set-codespaces-access-users"];
/**
@@ -2356,7 +2479,7 @@ export type paths = {
* To use this endpoint, the access settings for the organization must be set to `selected_members`.
* For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."
*
- * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["codespaces/delete-codespaces-access-users"];
readonly options?: never;
@@ -2373,8 +2496,10 @@ export type paths = {
};
/**
* List organization secrets
- * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values.
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted
+ * values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-org-secrets"];
readonly put?: never;
@@ -2394,7 +2519,8 @@ export type paths = {
};
/**
* Get an organization public key
- * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-org-public-key"];
readonly put?: never;
@@ -2415,7 +2541,8 @@ export type paths = {
/**
* Get an organization secret
* @description Gets an organization development environment secret without revealing its encrypted value.
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-org-secret"];
/**
@@ -2423,14 +2550,15 @@ export type paths = {
* @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access
- * token with the `admin:org` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["codespaces/create-or-update-org-secret"];
readonly post?: never;
/**
* Delete an organization secret
- * @description Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Deletes an organization development environment secret using the secret name.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["codespaces/delete-org-secret"];
readonly options?: never;
@@ -2447,12 +2575,19 @@ export type paths = {
};
/**
* List selected repositories for an organization secret
- * @description Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Lists all repositories that have been selected when the `visibility`
+ * for repository access to a secret is set to `selected`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-selected-repos-for-org-secret"];
/**
* Set selected repositories for an organization secret
- * @description Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Replaces all repositories for an organization development environment secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["codespaces/set-selected-repos-for-org-secret"];
readonly post?: never;
@@ -2472,13 +2607,18 @@ export type paths = {
readonly get?: never;
/**
* Add selected repository to an organization secret
- * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["codespaces/add-selected-repo-to-org-secret"];
readonly post?: never;
/**
* Remove selected repository from an organization secret
- * @description Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Removes a repository from an organization development environment secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["codespaces/remove-selected-repo-from-org-secret"];
readonly options?: never;
@@ -2494,15 +2634,16 @@ export type paths = {
readonly cookie?: never;
};
/**
- * Get Copilot Business seat information and settings for an organization
+ * Get Copilot seat information and settings for an organization
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Gets information about an organization's Copilot Business subscription, including seat breakdown
+ * Gets information about an organization's Copilot subscription, including seat breakdown
* and code matching policies. To configure these settings, go to your organization's settings on GitHub.com.
- * For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)".
+ * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)".
+ *
+ * Only organization owners can configure and view details about the organization's Copilot Business subscription.
*
- * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must
- * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
readonly get: operations["copilot/get-copilot-organization-details"];
readonly put?: never;
@@ -2521,13 +2662,14 @@ export type paths = {
readonly cookie?: never;
};
/**
- * List all Copilot Business seat assignments for an organization
+ * List all Copilot seat assignments for an organization
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).
+ * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).
*
- * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must
- * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
readonly get: operations["copilot/list-copilot-seats"];
readonly put?: never;
@@ -2548,33 +2690,35 @@ export type paths = {
readonly get?: never;
readonly put?: never;
/**
- * Add teams to the Copilot Business subscription for an organization
+ * Add teams to the Copilot subscription for an organization
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Purchases a GitHub Copilot Business seat for all users within each specified team.
- * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)".
+ * Purchases a GitHub Copilot seat for all users within each specified team.
+ * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
+ *
+ * Only organization owners can configure GitHub Copilot in their organization.
*
- * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
- * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.
+ * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)".
+ * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
*
- * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy.
- * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)".
- * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
- readonly post: operations["copilot/add-copilot-for-business-seats-for-teams"];
+ readonly post: operations["copilot/add-copilot-seats-for-teams"];
/**
- * Remove teams from the Copilot Business subscription for an organization
+ * Remove teams from the Copilot subscription for an organization
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Cancels the Copilot Business seat assignment for all members of each team specified.
+ * Cancels the Copilot seat assignment for all members of each team specified.
* This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.
*
- * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)".
+ * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
*
- * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
+ * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
*
- * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
- * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * Only organization owners can configure GitHub Copilot in their organization.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
readonly delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"];
readonly options?: never;
@@ -2592,33 +2736,35 @@ export type paths = {
readonly get?: never;
readonly put?: never;
/**
- * Add users to the Copilot Business subscription for an organization
+ * Add users to the Copilot subscription for an organization
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Purchases a GitHub Copilot Business seat for each user specified.
- * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)".
+ * Purchases a GitHub Copilot seat for each user specified.
+ * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
+ *
+ * Only organization owners can configure GitHub Copilot in their organization.
*
- * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
- * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.
+ * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)".
+ * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
*
- * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy.
- * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)".
- * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
- readonly post: operations["copilot/add-copilot-for-business-seats-for-users"];
+ readonly post: operations["copilot/add-copilot-seats-for-users"];
/**
- * Remove users from the Copilot Business subscription for an organization
+ * Remove users from the Copilot subscription for an organization
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Cancels the Copilot Business seat assignment for each user specified.
+ * Cancels the Copilot seat assignment for each user specified.
* This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.
*
- * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)"
+ * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
*
- * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
+ * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
*
- * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
- * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * Only organization owners can configure GitHub Copilot in their organization.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
readonly delete: operations["copilot/cancel-copilot-seat-assignment-for-users"];
readonly options?: never;
@@ -2626,6 +2772,39 @@ export type paths = {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/orgs/{org}/copilot/usage": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get a summary of Copilot usage for organization members
+ * @description **Note**: This endpoint is in beta and is subject to change.
+ *
+ * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
+ * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
+ * See the response schema tab for detailed metrics definitions.
+ *
+ * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,
+ * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
+ * they must have telemetry enabled in their IDE.
+ *
+ * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view
+ * Copilot usage metrics.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint.
+ */
+ readonly get: operations["copilot/usage-metrics-for-org"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/orgs/{org}/dependabot/alerts": {
readonly parameters: {
readonly query?: never;
@@ -2637,11 +2816,9 @@ export type paths = {
* List Dependabot alerts for an organization
* @description Lists Dependabot alerts 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 `security_events` scope.
+ * The authenticated user must be an owner or security manager for the organization to use this endpoint.
*
- * For public repositories, you may instead use the `public_repo` scope.
- *
- * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["dependabot/list-alerts-for-org"];
readonly put?: never;
@@ -2661,7 +2838,10 @@ export type paths = {
};
/**
* List organization secrets
- * @description Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Lists all secrets available in an organization without revealing their
+ * encrypted values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["dependabot/list-org-secrets"];
readonly put?: never;
@@ -2681,7 +2861,10 @@ export type paths = {
};
/**
* Get an organization public key
- * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["dependabot/get-org-public-key"];
readonly put?: never;
@@ -2701,7 +2884,9 @@ export type paths = {
};
/**
* Get an organization secret
- * @description Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Gets a single organization secret without revealing its encrypted value.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["dependabot/get-org-secret"];
/**
@@ -2709,15 +2894,15 @@ export type paths = {
* @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access
- * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization
- * permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["dependabot/create-or-update-org-secret"];
readonly post?: never;
/**
* Delete an organization secret
- * @description Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Deletes a secret in an organization using the secret name.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["dependabot/delete-org-secret"];
readonly options?: never;
@@ -2734,12 +2919,19 @@ export type paths = {
};
/**
* List selected repositories for an organization secret
- * @description Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Lists all repositories that have been selected when the `visibility`
+ * for repository access to a secret is set to `selected`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["dependabot/list-selected-repos-for-org-secret"];
/**
* Set selected repositories for an organization secret
- * @description Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Replaces all repositories for an organization secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["dependabot/set-selected-repos-for-org-secret"];
readonly post?: never;
@@ -2759,13 +2951,21 @@ export type paths = {
readonly get?: never;
/**
* Add selected repository to an organization secret
- * @description Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Adds a repository to an organization secret when the `visibility` for
+ * repository access is set to `selected`. The visibility is set when you [Create or
+ * update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["dependabot/add-selected-repo-to-org-secret"];
readonly post?: never;
/**
* Remove selected repository from an organization secret
- * @description Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Removes a repository from an organization secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["dependabot/remove-selected-repo-from-org-secret"];
readonly options?: never;
@@ -2783,7 +2983,8 @@ export type paths = {
/**
* Get list of conflicting packages during Docker migration for organization
* @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
*/
readonly get: operations["packages/list-docker-migration-conflicting-packages-for-organization"];
readonly put?: never;
@@ -2838,12 +3039,23 @@ export type paths = {
readonly path?: never;
readonly cookie?: never;
};
- /** List organization webhooks */
+ /**
+ * List organization webhooks
+ * @description You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
+ */
readonly get: operations["orgs/list-webhooks"];
readonly put?: never;
/**
* Create an organization webhook
- * @description Here's how you can create a hook that posts payloads in JSON format:
+ * @description Create a hook that posts payloads in JSON format.
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or
+ * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly post: operations["orgs/create-webhook"];
readonly delete?: never;
@@ -2861,18 +3073,39 @@ export type paths = {
};
/**
* Get an organization webhook
- * @description Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)."
+ * @description Returns a webhook configured in an organization. To get only the webhook
+ * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly get: operations["orgs/get-webhook"];
readonly put?: never;
readonly post?: never;
- /** Delete an organization webhook */
+ /**
+ * Delete an organization webhook
+ * @description You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
+ */
readonly delete: operations["orgs/delete-webhook"];
readonly options?: never;
readonly head?: never;
/**
* Update an organization webhook
- * @description Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. 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 an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)."
+ * @description Updates a webhook configured in an organization. When you update a webhook,
+ * the `secret` will be overwritten. 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 an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)".
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly patch: operations["orgs/update-webhook"];
readonly trace?: never;
@@ -2888,7 +3121,10 @@ export type paths = {
* Get a webhook configuration for an organization
* @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)."
*
- * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly get: operations["orgs/get-webhook-config-for-org"];
readonly put?: never;
@@ -2900,7 +3136,10 @@ export type paths = {
* Update a webhook configuration for an organization
* @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)."
*
- * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly patch: operations["orgs/update-webhook-config-for-org"];
readonly trace?: never;
@@ -2915,6 +3154,11 @@ export type paths = {
/**
* List deliveries for an organization webhook
* @description Returns a list of webhook deliveries for a webhook configured in an organization.
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly get: operations["orgs/list-webhook-deliveries"];
readonly put?: never;
@@ -2935,6 +3179,11 @@ export type paths = {
/**
* Get a webhook delivery for an organization webhook
* @description Returns a delivery for a webhook configured in an organization.
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly get: operations["orgs/get-webhook-delivery"];
readonly put?: never;
@@ -2957,6 +3206,11 @@ export type paths = {
/**
* Redeliver a delivery for an organization webhook
* @description Redeliver a delivery for a webhook configured in an organization.
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly post: operations["orgs/redeliver-webhook-delivery"];
readonly delete?: never;
@@ -2976,7 +3230,13 @@ export type paths = {
readonly put?: never;
/**
* Ping an organization webhook
- * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.
+ * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)
+ * to be sent to the hook.
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly post: operations["orgs/ping-webhook"];
readonly delete?: never;
@@ -3016,7 +3276,12 @@ export type paths = {
};
/**
* List app installations for an organization
- * @description Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.
+ * @description Lists all GitHub Apps in an organization. The installation count includes
+ * all GitHub Apps installed on repositories in the organization.
+ *
+ * The authenticated user must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint.
*/
readonly get: operations["orgs/list-app-installations"];
readonly put?: never;
@@ -3139,6 +3404,13 @@ export type paths = {
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/list-for-org"];
readonly put?: never;
@@ -3204,7 +3476,7 @@ export type paths = {
* List codespaces for a user in organization
* @description Lists the codespaces that a member of an organization has for repositories in that organization.
*
- * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-codespaces-for-user-in-org"];
readonly put?: never;
@@ -3229,10 +3501,7 @@ export type paths = {
* Delete a codespace from the organization
* @description Deletes a user's codespace.
*
- * To use this endpoint you must authenticate using one of the following methods:
- *
- * - An access token with the `admin:org` scope
- * - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces`
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["codespaces/delete-from-organization"];
readonly options?: never;
@@ -3253,10 +3522,7 @@ export type paths = {
* Stop a codespace for an organization user
* @description Stops a user's codespace.
*
- * To use this endpoint you must authenticate using one of the following methods:
- *
- * - An access token with the `admin:org` scope
- * - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces`
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly post: operations["codespaces/stop-in-organization"];
readonly delete?: never;
@@ -3273,12 +3539,14 @@ export type paths = {
readonly cookie?: never;
};
/**
- * Get Copilot Business seat assignment details for a user
+ * Get Copilot seat assignment details for a user
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot.
+ * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.
+ *
+ * Organization owners can view GitHub Copilot seat assignment details for members in their organization.
*
- * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
readonly get: operations["copilot/get-copilot-seat-details-for-user"];
readonly put?: never;
@@ -3453,9 +3721,7 @@ export type paths = {
};
/**
* List organization fine-grained permissions for an organization
- * @description **Note**: This operation is in beta and subject to change.
- *
- * Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
* To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)."
*
@@ -3464,8 +3730,7 @@ export type paths = {
* - An administrator for the organization.
* - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.
*
- * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint.
- * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["orgs/list-organization-fine-grained-permissions"];
readonly put?: never;
@@ -3485,33 +3750,27 @@ export type paths = {
};
/**
* Get all organization roles for an organization
- * @description Lists the organization roles available in this organization.
+ * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
* To use this endpoint, the authenticated user must be one of:
*
* - An administrator for the organization.
* - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.
*
- * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint.
- * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint.
- *
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["orgs/list-org-roles"];
readonly put?: never;
/**
* Create a custom organization role
- * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization.
+ * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
* To use this endpoint, the authenticated user must be one of:
*
* - An administrator for the organization.
* - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.
*
- * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint.
- * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint.
- *
- * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly post: operations["orgs/create-custom-organization-role"];
readonly delete?: never;
@@ -3532,12 +3791,11 @@ export type paths = {
readonly post?: never;
/**
* Remove all organization roles for a team
- * @description Removes all assigned organization roles from a team.
+ * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members:write` organization permission to use this endpoint.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["orgs/revoke-all-org-roles-team"];
readonly options?: never;
@@ -3555,22 +3813,21 @@ export type paths = {
readonly get?: never;
/**
* Assign an organization role to a team
- * @description Assigns an organization role to a team in an organization.
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members` organization read-write permission to use this endpoint.
+ * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ *
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["orgs/assign-team-to-org-role"];
readonly post?: never;
/**
* Remove an organization role from a team
- * @description Removes an organization role from a team.
+ * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members:write` organization permission to use this endpoint.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["orgs/revoke-org-role-team"];
readonly options?: never;
@@ -3590,12 +3847,11 @@ export type paths = {
readonly post?: never;
/**
* Remove all organization roles for a user
- * @description Revokes all assigned organization roles from a user.
+ * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members:write` organization permission to use this endpoint.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["orgs/revoke-all-org-roles-user"];
readonly options?: never;
@@ -3613,22 +3869,21 @@ export type paths = {
readonly get?: never;
/**
* Assign an organization role to a user
- * @description Assigns an organization role to a member of an organization.
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members` organization read-write permission to use this endpoint.
+ * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * The authenticated user must be an administrator for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["orgs/assign-user-to-org-role"];
readonly post?: never;
/**
* Remove an organization role from a user
- * @description Remove an organization role from a user.
+ * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members:write` organization permission to use this endpoint.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["orgs/revoke-org-role-user"];
readonly options?: never;
@@ -3645,51 +3900,43 @@ export type paths = {
};
/**
* Get an organization role
- * @description Gets an organization role that is available to this organization.
+ * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
* To use this endpoint, the authenticated user must be one of:
*
* - An administrator for the organization.
* - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.
*
- * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint.
- * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint.
- *
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["orgs/get-org-role"];
readonly put?: never;
readonly post?: never;
/**
* Delete a custom organization role.
- * @description Deletes a custom organization role.
+ * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
* To use this endpoint, the authenticated user must be one of:
*
* - An administrator for the organization.
* - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.
*
- * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint.
- * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint.
- *
- * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["orgs/delete-custom-organization-role"];
readonly options?: never;
readonly head?: never;
/**
* Update a custom organization role
- * @description Updates an existing custom organization role. Permission changes will apply to all assignees.
+ * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ *
*
* To use this endpoint, the authenticated user must be one of:
*
* - An administrator for the organization.
* - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.
*
- * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint.
- * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint.
- *
- * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly patch: operations["orgs/patch-custom-organization-role"];
readonly trace?: never;
@@ -3703,12 +3950,11 @@ export type paths = {
};
/**
* List teams that are assigned to an organization role
- * @description Lists the teams that are assigned to an organization role.
+ * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members` organization read permission to use this endpoint.
+ * To use this endpoint, you must be an administrator for the organization.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["orgs/list-org-role-teams"];
readonly put?: never;
@@ -3728,12 +3974,11 @@ export type paths = {
};
/**
* List users that are assigned to an organization role
- * @description Lists organization members that are assigned to an organization role.
+ * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members` organization read permission to use this endpoint.
+ * To use this endpoint, you must be an administrator for the organization.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["orgs/list-org-role-users"];
readonly put?: never;
@@ -3799,7 +4044,7 @@ export type paths = {
* List packages for an organization
* @description Lists packages in an organization readable by the user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/list-packages-for-organization"];
readonly put?: never;
@@ -3821,7 +4066,7 @@ export type paths = {
* Get a package for an organization
* @description Gets a specific package in an organization.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-package-for-organization"];
readonly put?: never;
@@ -3830,9 +4075,9 @@ export type paths = {
* Delete a package for an organization
* @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly delete: operations["packages/delete-package-for-org"];
readonly options?: never;
@@ -3857,9 +4102,9 @@ export type paths = {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly post: operations["packages/restore-package-for-org"];
readonly delete?: never;
@@ -3879,7 +4124,7 @@ export type paths = {
* List package versions for a package owned by an organization
* @description Lists package versions for a package owned by an organization.
*
- * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-all-package-versions-for-package-owned-by-org"];
readonly put?: never;
@@ -3901,7 +4146,7 @@ export type paths = {
* Get a package version for an organization
* @description Gets a specific package version in an organization.
*
- * You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-package-version-for-organization"];
readonly put?: never;
@@ -3910,9 +4155,9 @@ export type paths = {
* Delete package version for an organization
* @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly delete: operations["packages/delete-package-version-for-org"];
readonly options?: never;
@@ -3937,9 +4182,9 @@ export type paths = {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly post: operations["packages/restore-package-version-for-org"];
readonly delete?: never;
@@ -3957,19 +4202,17 @@ export type paths = {
};
/**
* List requests to access organization resources with fine-grained personal access tokens
- * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API,
- * using the `organization_personal_access_token_requests: read` permission.
+ * @description Lists requests from organization members to access organization resources with a fine-grained personal access token.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly get: operations["orgs/list-pat-grant-requests"];
readonly put?: never;
/**
* Review requests to access organization resources with fine-grained personal access tokens
- * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,
- * using the `organization_personal_access_token_requests: write` permission.
+ * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly post: operations["orgs/review-pat-grant-requests-in-bulk"];
readonly delete?: never;
@@ -3989,10 +4232,9 @@ export type paths = {
readonly put?: never;
/**
* Review a request to access organization resources with a fine-grained personal access token
- * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,
- * using the `organization_personal_access_token_requests: write` permission.
+ * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly post: operations["orgs/review-pat-grant-request"];
readonly delete?: never;
@@ -4010,10 +4252,9 @@ export type paths = {
};
/**
* List repositories requested to be accessed by a fine-grained personal access token
- * @description Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API,
- * using the `organization_personal_access_token_requests: read` permission.
+ * @description Lists the repositories a fine-grained personal access token request is requesting access to.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly get: operations["orgs/list-pat-grant-request-repositories"];
readonly put?: never;
@@ -4033,19 +4274,17 @@ export type paths = {
};
/**
* List fine-grained personal access tokens with access to organization resources
- * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API,
- * using the `organization_personal_access_tokens: read` permission.
+ * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly get: operations["orgs/list-pat-grants"];
readonly put?: never;
/**
* Update the access to organization resources via fine-grained personal access tokens
- * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API,
- * using the `organization_personal_access_tokens: write` permission.
+ * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly post: operations["orgs/update-pat-accesses"];
readonly delete?: never;
@@ -4065,10 +4304,9 @@ export type paths = {
readonly put?: never;
/**
* Update the access a fine-grained personal access token has to organization resources
- * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API,
- * using the `organization_personal_access_tokens: write` permission.
+ * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly post: operations["orgs/update-pat-access"];
readonly delete?: never;
@@ -4086,10 +4324,9 @@ export type paths = {
};
/**
* List repositories a fine-grained personal access token has access to
- * @description Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API,
- * using the `organization_personal_access_tokens: read` permission.
+ * @description Lists the repositories a fine-grained personal access token has access to.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly get: operations["orgs/list-pat-grant-repositories"];
readonly put?: never;
@@ -4134,7 +4371,7 @@ export type paths = {
/**
* Get all custom properties for an organization
* @description Gets all custom properties defined for an organization.
- * You must be an organization owner to use this endpoint.
+ * Organization members can read these properties.
*/
readonly get: operations["orgs/get-all-custom-properties"];
readonly put?: never;
@@ -4145,7 +4382,10 @@ export type paths = {
/**
* Create or update custom properties for an organization
* @description Creates new or updates existing custom properties defined for an organization in a batch.
- * Only organization owners (or users with the proper permissions granted by them) can update these properties
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
*/
readonly patch: operations["orgs/create-or-update-custom-properties"];
readonly trace?: never;
@@ -4160,20 +4400,26 @@ export type paths = {
/**
* Get a custom property for an organization
* @description Gets a custom property that is defined for an organization.
- * You must be an organization owner to use this endpoint.
+ * Organization members can read these properties.
*/
readonly get: operations["orgs/get-custom-property"];
/**
* Create or update a custom property for an organization
* @description Creates a new or updates an existing custom property that is defined for an organization.
- * You must be an organization owner to use this endpoint.
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
*/
readonly put: operations["orgs/create-or-update-custom-property"];
readonly post?: never;
/**
* Remove a custom property for an organization
* @description Removes a custom property that is defined for an organization.
- * You must be an organization owner to use this endpoint.
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
*/
readonly delete: operations["orgs/remove-custom-property"];
readonly options?: never;
@@ -4208,7 +4454,9 @@ export type paths = {
*
* Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.
*
- * Only organization owners (or users with the proper permissions granted by them) can update these properties
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.
*/
readonly patch: operations["orgs/create-or-update-custom-properties-values-for-repos"];
readonly trace?: never;
@@ -4249,7 +4497,7 @@ export type paths = {
* Set public organization membership for the authenticated user
* @description The user can publicize their own membership. (A user cannot publicize the membership for another user.)
*
- * Note that 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)."
+ * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
readonly put: operations["orgs/set-public-membership-for-authenticated-user"];
readonly post?: never;
@@ -4282,12 +4530,7 @@ export type paths = {
* Create an organization repository
* @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
*
- * **OAuth scope requirements**
- *
- * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
- *
- * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- * * `repo` scope to create a private repository
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
*/
readonly post: operations["repos/create-in-org"];
readonly delete?: never;
@@ -4400,10 +4643,10 @@ export type paths = {
/**
* List secret scanning alerts for an organization
* @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.
- * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * The authenticated user must be an administrator or security manager for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["secret-scanning/list-alerts-for-org"];
readonly put?: never;
@@ -4425,7 +4668,9 @@ export type paths = {
* 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.
+ * The authenticated user must be an owner or security manager for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
*/
readonly get: operations["security-advisories/list-org-repository-advisories"];
readonly put?: never;
@@ -4447,9 +4692,9 @@ export type paths = {
* 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)."
*
- * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope.
+ * The authenticated user must be an administrator or security manager for the organization to use this endpoint.
*
- * GitHub Apps must have the `administration` organization read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
*/
readonly get: operations["orgs/list-security-manager-teams"];
readonly put?: never;
@@ -4472,9 +4717,9 @@ export type paths = {
* Add a security manager team
* @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * GitHub Apps must have the `administration` organization read-write permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
*/
readonly put: operations["orgs/add-security-manager-team"];
readonly post?: never;
@@ -4482,9 +4727,9 @@ export type paths = {
* Remove a security manager team
* @description Removes the security manager role from a team 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) team from an organization."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * GitHub Apps must have the `administration` organization read-write permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["orgs/remove-security-manager-team"];
readonly options?: never;
@@ -4505,7 +4750,7 @@ export type paths = {
*
* Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * Access tokens must have the `repo` or `admin:org` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
*/
readonly get: operations["billing/get-github-actions-billing-org"];
readonly put?: never;
@@ -4529,7 +4774,7 @@ export type paths = {
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `repo` or `admin:org` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
*/
readonly get: operations["billing/get-github-packages-billing-org"];
readonly put?: never;
@@ -4553,7 +4798,7 @@ export type paths = {
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `repo` or `admin:org` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
*/
readonly get: operations["billing/get-shared-storage-billing-org"];
readonly put?: never;
@@ -4564,6 +4809,41 @@ export type paths = {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/orgs/{org}/team/{team_slug}/copilot/usage": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get a summary of Copilot usage for a team
+ * @description **Note**: This endpoint is in beta and is subject to change.
+ *
+ * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
+ * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
+ * See the response schema tab for detailed metrics definitions.
+ *
+ * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,
+ * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
+ * they must have telemetry enabled in their IDE.
+ *
+ * **Note**: This endpoint will only return results for a given day if the team had five or more members on that day.
+ *
+ * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team,
+ * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint.
+ */
+ readonly get: operations["copilot/usage-metrics-for-team"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/orgs/{org}/teams": {
readonly parameters: {
readonly query?: never;
@@ -4635,19 +4915,23 @@ export type paths = {
};
/**
* List discussions
- * @description List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description List all discussions on a team's page.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/list-discussions-in-org"];
readonly put?: never;
/**
* Create a discussion
- * @description Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Creates a new discussion post on a team's page.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["teams/create-discussion-in-org"];
readonly delete?: never;
@@ -4665,27 +4949,33 @@ export type paths = {
};
/**
* Get a discussion
- * @description Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Get a specific discussion on a team's page.
*
* **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}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/get-discussion-in-org"];
readonly put?: never;
readonly post?: never;
/**
* Delete a discussion
- * @description Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Delete a discussion from a team's page.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly delete: operations["teams/delete-discussion-in-org"];
readonly options?: never;
readonly head?: never;
/**
* Update a discussion
- * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly patch: operations["teams/update-discussion-in-org"];
readonly trace?: never;
@@ -4699,19 +4989,23 @@ export type paths = {
};
/**
* List discussion comments
- * @description List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description List all comments on a team discussion.
*
* **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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/list-discussion-comments-in-org"];
readonly put?: never;
/**
* Create a discussion comment
- * @description Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Creates a new comment on a team discussion.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
*
* **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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["teams/create-discussion-comment-in-org"];
readonly delete?: never;
@@ -4729,27 +5023,33 @@ export type paths = {
};
/**
* Get a discussion comment
- * @description Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Get a specific comment on a team discussion.
*
* **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}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/get-discussion-comment-in-org"];
readonly put?: never;
readonly post?: never;
/**
* Delete a discussion comment
- * @description Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Deletes a comment on a team discussion.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly delete: operations["teams/delete-discussion-comment-in-org"];
readonly options?: never;
readonly head?: never;
/**
* Update a discussion comment
- * @description Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Edits the body text of a discussion comment.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly patch: operations["teams/update-discussion-comment-in-org"];
readonly trace?: never;
@@ -4763,17 +5063,23 @@ export type paths = {
};
/**
* List reactions for a team discussion comment
- * @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/).
+ * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
*
* **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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["reactions/list-for-team-discussion-comment-in-org"];
readonly put?: never;
/**
* Create reaction for a 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.
+ * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * 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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["reactions/create-for-team-discussion-comment-in-org"];
readonly delete?: never;
@@ -4796,7 +5102,9 @@ export type 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/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 a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly delete: operations["reactions/delete-for-team-discussion-comment"];
readonly options?: never;
@@ -4813,17 +5121,23 @@ export type paths = {
};
/**
* List reactions for a team discussion
- * @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/).
+ * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
*
* **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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["reactions/list-for-team-discussion-in-org"];
readonly put?: never;
/**
* Create reaction for a 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.
+ * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
+ *
+ * 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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["reactions/create-for-team-discussion-in-org"];
readonly delete?: never;
@@ -4846,7 +5160,9 @@ export type 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/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 a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly delete: operations["reactions/delete-for-team-discussion"];
readonly options?: never;
@@ -5044,14 +5360,14 @@ export type paths = {
*
* If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.
*
- * If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status.
+ * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
*/
readonly get: operations["teams/check-permissions-for-repo-in-org"];
/**
* Add or update team repository permissions
- * @description 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. 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)."
+ * @description 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. 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
*
@@ -5104,14 +5420,11 @@ export type paths = {
readonly put?: never;
/**
* Enable or disable a security feature for an organization
- * @description Enables or disables the specified security feature for all eligible repositories in an organization.
- *
- * To use this endpoint, you must be an organization owner or be member of a team with the security manager role.
- * A token with the 'write:org' scope is also required.
+ * @description Enables or disables the specified security feature for all eligible repositories in 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)."
*
- * GitHub Apps must have the `organization_administration:write` permission to use this endpoint.
+ * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
*
- * 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)."
+ * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
*/
readonly post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"];
readonly delete?: never;
@@ -5354,7 +5667,7 @@ export type paths = {
*
* 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 `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/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)."
@@ -5392,10 +5705,12 @@ export type paths = {
readonly post?: never;
/**
* Delete a repository
- * @description Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.
+ * @description Deleting a repository requires admin access.
*
* If an organization owner has configured the organization to prevent members from deleting organization-owned
* repositories, you will get a `403 Forbidden` response.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.
*/
readonly delete: operations["repos/delete"];
readonly options?: never;
@@ -5416,7 +5731,11 @@ export type paths = {
};
/**
* List artifacts for a repository
- * @description Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Lists all artifacts for a repository.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/list-artifacts-for-repo"];
readonly put?: never;
@@ -5436,14 +5755,19 @@ export type paths = {
};
/**
* Get an artifact
- * @description Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Gets a specific artifact for a workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-artifact"];
readonly put?: never;
readonly post?: never;
/**
* Delete an artifact
- * @description Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * @description Deletes an artifact for a workflow run.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-artifact"];
readonly options?: never;
@@ -5463,8 +5787,7 @@ export type paths = {
* @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in
* the response header to find the URL for the download. The `:archive_format` must be `zip`.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/download-artifact"];
readonly put?: never;
@@ -5486,7 +5809,10 @@ export type paths = {
* Get GitHub Actions cache usage for a repository
* @description Gets GitHub Actions cache usage for a repository.
* The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-actions-cache-usage"];
readonly put?: never;
@@ -5507,8 +5833,8 @@ export type paths = {
/**
* List GitHub Actions caches for a repository
* @description Lists the GitHub Actions caches for a repository.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions:read` permission to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-actions-cache-list"];
readonly put?: never;
@@ -5517,9 +5843,7 @@ export type paths = {
* Delete GitHub Actions caches for a repository (using a cache key)
* @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- *
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-actions-cache-by-key"];
readonly options?: never;
@@ -5541,9 +5865,7 @@ export type paths = {
* Delete a GitHub Actions cache for a repository (using a cache ID)
* @description Deletes a GitHub Actions cache for a repository, using a cache ID.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- *
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-actions-cache-by-id"];
readonly options?: never;
@@ -5560,7 +5882,11 @@ export type paths = {
};
/**
* Get a job for a workflow run
- * @description Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Gets a specific job in a workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-job-for-workflow-run"];
readonly put?: never;
@@ -5581,9 +5907,11 @@ export type paths = {
/**
* Download job logs for a workflow run
* @description Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
- * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can
- * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must
- * have the `actions:read` permission to use this endpoint.
+ * for `Location:` in the response header to find the URL for the download.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/download-job-logs-for-workflow-run"];
readonly put?: never;
@@ -5607,8 +5935,7 @@ export type paths = {
* Re-run a job from a workflow run
* @description Re-run a job and its dependent jobs in a workflow run.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/re-run-job-for-workflow-run"];
readonly delete?: never;
@@ -5627,15 +5954,15 @@ export type paths = {
/**
* Get the customization template for an OIDC subject claim for a repository
* @description Gets the customization template for an OpenID Connect (OIDC) subject claim.
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-custom-oidc-sub-claim-for-repo"];
/**
* Set the customization template for an OIDC subject claim for a repository
* @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/set-custom-oidc-sub-claim-for-repo"];
readonly post?: never;
@@ -5657,9 +5984,9 @@ export type paths = {
* @description Lists all organization secrets shared with a repository without revealing their encrypted
* values.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-repo-organization-secrets"];
readonly put?: never;
@@ -5679,11 +6006,11 @@ export type paths = {
};
/**
* List repository organization variables
- * @description Lists all organiation variables shared with a repository.
+ * @description Lists all organization variables shared with a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-repo-organization-variables"];
readonly put?: never;
@@ -5705,14 +6032,14 @@ export type paths = {
* Get GitHub Actions permissions for a repository
* @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-github-actions-permissions-repository"];
/**
* Set GitHub Actions permissions for a repository
* @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/set-github-actions-permissions-repository"];
readonly post?: never;
@@ -5735,8 +6062,7 @@ export type paths = {
* This endpoint only applies to private repositories.
* For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
- * repository `administration` permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-workflow-access-to-repository"];
/**
@@ -5745,8 +6071,7 @@ export type paths = {
* This endpoint only applies to private repositories.
* For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)".
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
- * repository `administration` permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/set-workflow-access-to-repository"];
readonly post?: never;
@@ -5767,14 +6092,14 @@ export type paths = {
* Get allowed actions and reusable workflows for a repository
* @description Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-allowed-actions-repository"];
/**
* Set allowed actions and reusable workflows for a repository
* @description Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/set-allowed-actions-repository"];
readonly post?: never;
@@ -5797,7 +6122,7 @@ export type paths = {
* as well as if GitHub Actions can submit approving pull request reviews.
* For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-github-actions-default-workflow-permissions-repository"];
/**
@@ -5806,7 +6131,7 @@ export type paths = {
* can submit approving pull request reviews.
* For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/set-github-actions-default-workflow-permissions-repository"];
readonly post?: never;
@@ -5827,9 +6152,9 @@ export type paths = {
* List self-hosted runners for a repository
* @description Lists all self-hosted runners configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-self-hosted-runners-for-repo"];
readonly put?: never;
@@ -5851,9 +6176,9 @@ export type paths = {
* List runner applications for a repository
* @description Lists binaries for the runner application that you can download and run.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-runner-applications-for-repo"];
readonly put?: never;
@@ -5877,9 +6202,9 @@ export type paths = {
* Create configuration for a just-in-time runner for a repository
* @description Generates a configuration that can be passed to the runner application at startup.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * The authenticated user must have admin access to the repository.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.
*/
readonly post: operations["actions/generate-runner-jitconfig-for-repo"];
readonly delete?: never;
@@ -5899,19 +6224,17 @@ export type paths = {
readonly put?: never;
/**
* Create a registration token for a repository
- * @description Returns a token that you can pass to the `config` script. The token
- * expires after one hour.
+ * @description Returns a token that you can pass to the `config` script. The token expires after one hour.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
*
- * Example using registration token:
+ * ```
+ * ./config.sh --url https://github.com/octo-org --token TOKEN
+ * ```
*
- * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided
- * by this endpoint.
+ * Authenticated users must have admin access to the repository to use this endpoint.
*
- * ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-registration-token-for-repo"];
readonly delete?: never;
@@ -5931,19 +6254,17 @@ export type paths = {
readonly put?: never;
/**
* Create a remove token for a repository
- * @description Returns a token that you can pass to remove a self-hosted runner from
- * a repository. The token expires after one hour.
+ * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:
*
- * Example using remove token:
+ * ```
+ * ./config.sh remove --token TOKEN
+ * ```
*
- * To remove your self-hosted runner from a repository, replace TOKEN with
- * the remove token provided by this endpoint.
+ * Authenticated users must have admin access to the repository to use this endpoint.
*
- * ```config.sh remove --token TOKEN```
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-remove-token-for-repo"];
readonly delete?: never;
@@ -5963,9 +6284,9 @@ export type paths = {
* Get a self-hosted runner for a repository
* @description Gets a specific self-hosted runner configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-self-hosted-runner-for-repo"];
readonly put?: never;
@@ -5974,9 +6295,9 @@ export type paths = {
* Delete a self-hosted runner from a repository
* @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-self-hosted-runner-from-repo"];
readonly options?: never;
@@ -5995,9 +6316,9 @@ export type paths = {
* List labels for a self-hosted runner for a repository
* @description Lists all labels for a self-hosted runner configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-labels-for-self-hosted-runner-for-repo"];
/**
@@ -6005,18 +6326,18 @@ export type paths = {
* @description Remove all previous custom labels and set the new custom labels for a specific
* self-hosted runner configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"];
/**
* Add custom labels to a self-hosted runner for a repository
- * @description Add custom labels to a self-hosted runner configured in a repository.
+ * @description Adds custom labels to a self-hosted runner configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"];
/**
@@ -6024,9 +6345,9 @@ export type paths = {
* @description Remove all custom labels from a self-hosted runner configured in a
* repository. Returns the remaining read-only labels from the runner.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"];
readonly options?: never;
@@ -6052,9 +6373,9 @@ export type paths = {
* This endpoint returns a `404 Not Found` status if the custom label is not
* present on the runner.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"];
readonly options?: never;
@@ -6071,9 +6392,13 @@ export type paths = {
};
/**
* List workflow runs for a repository
- * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
+ * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ *
+ * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.
*/
readonly get: operations["actions/list-workflow-runs-for-repo"];
readonly put?: never;
@@ -6093,16 +6418,22 @@ export type paths = {
};
/**
* Get a workflow run
- * @description Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Gets a specific workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/get-workflow-run"];
readonly put?: never;
readonly post?: never;
/**
* Delete a workflow run
- * @description Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is
- * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use
- * this endpoint.
+ * @description Deletes a specific workflow run.
+ *
+ * Anyone with write access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-workflow-run"];
readonly options?: never;
@@ -6119,7 +6450,9 @@ export type paths = {
};
/**
* Get the review history for a workflow run
- * @description Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/get-reviews-for-run"];
readonly put?: never;
@@ -6143,7 +6476,7 @@ export type paths = {
* Approve a workflow run for a fork pull request
* @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/approve-workflow-run"];
readonly delete?: never;
@@ -6161,7 +6494,11 @@ export type paths = {
};
/**
* List workflow run artifacts
- * @description Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Lists artifacts for a workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/list-workflow-run-artifacts"];
readonly put?: never;
@@ -6181,10 +6518,11 @@ export type paths = {
};
/**
* Get a workflow run attempt
- * @description Gets a specific workflow run attempt. Anyone with read access to the repository
- * can use this endpoint. If the repository is private you must use an access token
- * with the `repo` scope. GitHub Apps must have the `actions:read` permission to
- * use this endpoint.
+ * @description Gets a specific workflow run attempt.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/get-workflow-run-attempt"];
readonly put?: never;
@@ -6204,7 +6542,12 @@ export type paths = {
};
/**
* List jobs for a workflow run attempt
- * @description Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
+ * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information
+ * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/list-jobs-for-workflow-run-attempt"];
readonly put?: never;
@@ -6225,9 +6568,11 @@ export type paths = {
/**
* Download workflow run attempt logs
* @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
- * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to
- * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
- * GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * 1 minute. Look for `Location:` in the response header to find the URL for the download.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/download-workflow-run-attempt-logs"];
readonly put?: never;
@@ -6251,8 +6596,7 @@ export type paths = {
* Cancel a workflow run
* @description Cancels a workflow run using its `id`.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/cancel-workflow-run"];
readonly delete?: never;
@@ -6277,8 +6621,7 @@ export type paths = {
* **Note:** GitHub Apps can only review their own custom deployment protection rules.
* To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).
*
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have read and write permission for **Deployments** to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly post: operations["actions/review-custom-gates-for-run"];
readonly delete?: never;
@@ -6301,8 +6644,7 @@ export type paths = {
* @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
* You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/force-cancel-workflow-run"];
readonly delete?: never;
@@ -6320,7 +6662,12 @@ export type paths = {
};
/**
* List jobs for a workflow run
- * @description Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
+ * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information
+ * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/list-jobs-for-workflow-run"];
readonly put?: never;
@@ -6341,16 +6688,20 @@ export type paths = {
/**
* Download workflow run logs
* @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
- * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use
- * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have
- * the `actions:read` permission to use this endpoint.
+ * `Location:` in the response header to find the URL for the download.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/download-workflow-run-logs"];
readonly put?: never;
readonly post?: never;
/**
* Delete workflow run logs
- * @description Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * @description Deletes all logs for a workflow run.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-workflow-run-logs"];
readonly options?: never;
@@ -6369,7 +6720,9 @@ export type paths = {
* Get pending deployments for a workflow run
* @description Get all deployment environments for a workflow run that are waiting for protection rules to pass.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-pending-deployments-for-run"];
readonly put?: never;
@@ -6377,7 +6730,9 @@ export type paths = {
* Review pending deployments for a workflow run
* @description Approve or reject pending deployments that are waiting on approval by a required reviewer.
*
- * Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.
+ * Required reviewers with read access to the repository contents and deployments can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/review-pending-deployments-for-run"];
readonly delete?: never;
@@ -6397,7 +6752,9 @@ export type paths = {
readonly put?: never;
/**
* Re-run a workflow
- * @description Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * @description Re-runs your workflow run using its `id`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/re-run-workflow"];
readonly delete?: never;
@@ -6417,7 +6774,9 @@ export type paths = {
readonly put?: never;
/**
* Re-run failed jobs from a workflow run
- * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint.
+ * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/re-run-workflow-failed-jobs"];
readonly delete?: never;
@@ -6437,7 +6796,9 @@ export type paths = {
* Get workflow run usage
* @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/get-workflow-run-usage"];
readonly put?: never;
@@ -6460,9 +6821,9 @@ export type paths = {
* @description Lists all secrets available in a repository without revealing their encrypted
* values.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-repo-secrets"];
readonly put?: never;
@@ -6486,9 +6847,8 @@ export type paths = {
* encrypt a secret before you can create or update secrets.
*
* Anyone with read access to the repository can use this endpoint.
- * If the repository is private you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-repo-public-key"];
readonly put?: never;
@@ -6510,9 +6870,9 @@ export type paths = {
* Get a repository secret
* @description Gets a single repository secret without revealing its encrypted value.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ * The authenticated user must have collaborator access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-repo-secret"];
/**
@@ -6520,9 +6880,9 @@ export type paths = {
* @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/create-or-update-repo-secret"];
readonly post?: never;
@@ -6530,9 +6890,9 @@ export type paths = {
* Delete a repository secret
* @description Deletes a secret in a repository using the secret name.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-repo-secret"];
readonly options?: never;
@@ -6550,9 +6910,10 @@ export type paths = {
/**
* List repository variables
* @description Lists all repository variables.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
+ *
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-repo-variables"];
readonly put?: never;
@@ -6560,9 +6921,9 @@ export type paths = {
* Create a repository variable
* @description Creates a repository variable that you can reference in a GitHub Actions workflow.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-repo-variable"];
readonly delete?: never;
@@ -6582,9 +6943,9 @@ export type paths = {
* Get a repository variable
* @description Gets a specific variable in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ * The authenticated user must have collaborator access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-repo-variable"];
readonly put?: never;
@@ -6593,9 +6954,9 @@ export type paths = {
* Delete a repository variable
* @description Deletes a repository variable using the variable name.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-repo-variable"];
readonly options?: never;
@@ -6604,9 +6965,9 @@ export type paths = {
* Update a repository variable
* @description Updates a repository variable that you can reference in a GitHub Actions workflow.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly patch: operations["actions/update-repo-variable"];
readonly trace?: never;
@@ -6620,7 +6981,11 @@ export type paths = {
};
/**
* List repository workflows
- * @description Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Lists the workflows in a repository.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/list-repo-workflows"];
readonly put?: never;
@@ -6640,7 +7005,12 @@ export type paths = {
};
/**
* Get a workflow
- * @description Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Gets a specific workflow. You can replace `workflow_id` with the workflow
+ * file name. For example, you could use `main.yaml`.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/get-workflow"];
readonly put?: never;
@@ -6663,7 +7033,7 @@ export type paths = {
* Disable a workflow
* @description Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/disable-workflow"];
readonly post?: never;
@@ -6688,7 +7058,7 @@ export type paths = {
*
* You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)."
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-workflow-dispatch"];
readonly delete?: never;
@@ -6709,7 +7079,7 @@ export type paths = {
* Enable a workflow
* @description Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/enable-workflow"];
readonly post?: never;
@@ -6728,9 +7098,11 @@ export type paths = {
};
/**
* List workflow runs for a workflow
- * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
+ * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
+ * Anyone with read access to the repository can use this endpoint
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/list-workflow-runs"];
readonly put?: never;
@@ -6752,7 +7124,11 @@ export type paths = {
* Get workflow usage
* @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/get-workflow-usage"];
readonly put?: never;
@@ -6838,8 +7214,8 @@ export type paths = {
readonly cookie?: never;
};
/**
- * List all autolinks of a repository
- * @description This returns a list of autolinks configured for the given repository.
+ * Get all autolinks of a repository
+ * @description Gets all autolinks that are configured for a repository.
*
* Information about autolinks are only available to repository administrators.
*/
@@ -7183,28 +7559,28 @@ export type paths = {
* Get apps with access to the protected branch
* @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
+ * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
readonly get: operations["repos/get-apps-with-access-to-protected-branch"];
/**
* Set app access restrictions
* @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
+ * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
readonly put: operations["repos/set-app-access-restrictions"];
/**
* Add app access restrictions
* @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
+ * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
readonly post: operations["repos/add-app-access-restrictions"];
/**
* Remove app access restrictions
* @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
+ * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
readonly delete: operations["repos/remove-app-access-restrictions"];
readonly options?: never;
@@ -7319,17 +7695,9 @@ export type paths = {
*
* **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)".
*
- * The permissions required to use this endpoint depends on whether you are renaming the default branch.
- *
- * To rename a non-default branch:
- *
- * * Users must have push access.
- * * GitHub Apps must have the `contents:write` repository permission.
+ * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
*
- * To rename the default branch:
- *
- * * Users must have admin or owner permissions.
- * * GitHub Apps must have the `administration:write` repository permission.
+ * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.
*/
readonly post: operations["repos/rename-branch"];
readonly delete?: never;
@@ -7349,11 +7717,13 @@ export type paths = {
readonly put?: never;
/**
* Create a check run
- * @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.
+ * @description Creates a new check run for a specific commit in a repository.
*
- * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.
+ * To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
*
* In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
+ *
+ * **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.
*/
readonly post: operations["checks/create"];
readonly delete?: never;
@@ -7371,9 +7741,11 @@ export type paths = {
};
/**
* Get a check run
- * @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.
+ * @description Gets a single check run using its `id`.
*
- * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.
+ * **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.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
readonly get: operations["checks/get"];
readonly put?: never;
@@ -7383,9 +7755,11 @@ export type paths = {
readonly head?: never;
/**
* Update a check run
- * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.
+ * @description Updates a check run for a specific commit in a repository.
*
* **Note:** The endpoints to manage checks only look 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.
+ *
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
*/
readonly patch: operations["checks/update"];
readonly trace?: never;
@@ -7399,7 +7773,9 @@ export type paths = {
};
/**
* List check run annotations
- * @description Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.
+ * @description Lists annotations for a check run using the annotation `id`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
readonly get: operations["checks/list-annotations"];
readonly put?: never;
@@ -7423,9 +7799,9 @@ export type paths = {
* Rerequest a check run
* @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
*
- * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.
- *
* For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".
+ *
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
*/
readonly post: operations["checks/rerequest-run"];
readonly delete?: never;
@@ -7445,9 +7821,11 @@ export type paths = {
readonly put?: never;
/**
* 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`.
+ * @description Creates a check suite manually. 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)".
*
- * 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.
+ * **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`.
+ *
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
*/
readonly post: operations["checks/create-suite"];
readonly delete?: never;
@@ -7471,7 +7849,8 @@ export type paths = {
readonly head?: never;
/**
* Update repository preferences for check suites
- * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.
+ * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).
+ * You must have admin permissions in the repository to set preferences for check suites.
*/
readonly patch: operations["checks/set-suites-preferences"];
readonly trace?: never;
@@ -7485,9 +7864,11 @@ export type paths = {
};
/**
* Get 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`.
+ * @description Gets a single check suite using its `id`.
+ *
+ * **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`.
*
- * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
readonly get: operations["checks/get-suite"];
readonly put?: never;
@@ -7507,9 +7888,11 @@ export type paths = {
};
/**
* List check runs in a check suite
- * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.
+ * @description Lists check runs for a check suite using its `id`.
*
* **Note:** The endpoints to manage checks only look 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.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
readonly get: operations["checks/list-for-suite"];
readonly put?: never;
@@ -7533,7 +7916,7 @@ export type paths = {
* Rerequest a check suite
* @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
*
- * To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository.
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
*/
readonly post: operations["checks/rerequest-suite"];
readonly delete?: never;
@@ -7553,11 +7936,11 @@ export type paths = {
* List code scanning alerts for a repository
* @description Lists code scanning alerts.
*
- * To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope.
- *
* The response includes a `most_recent_instance` object.
* This provides details of the most recent instance of this alert
* for the default branch (or for the specified Git reference if you used `ref` in the request).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/list-alerts-for-repo"];
readonly put?: never;
@@ -7577,7 +7960,9 @@ export type paths = {
};
/**
* Get a code scanning alert
- * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only.
+ * @description Gets a single code scanning alert.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/get-alert"];
readonly put?: never;
@@ -7587,7 +7972,8 @@ export type paths = {
readonly head?: never;
/**
* Update a code scanning alert
- * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only.
+ * @description Updates the status of a single code scanning alert.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly patch: operations["code-scanning/update-alert"];
readonly trace?: never;
@@ -7602,8 +7988,8 @@ export type paths = {
/**
* List instances of a code scanning alert
* @description Lists all instances of the specified code scanning alert.
- * You must use an access token with the `security_events` scope to use this endpoint with private repos,
- * the `public_repo` scope also grants permission to read security events on public repos only.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/list-alert-instances"];
readonly put?: never;
@@ -7634,11 +8020,10 @@ export type paths = {
* For very old analyses this data is not available,
* and `0` is returned in this field.
*
- * You must use an access token with the `security_events` scope to use this endpoint with private repos,
- * the `public_repo` scope also grants permission to read security events on public repos only.
- *
* **Deprecation notice**:
* The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/list-recent-analyses"];
readonly put?: never;
@@ -7659,8 +8044,6 @@ export type paths = {
/**
* Get a code scanning analysis for a repository
* @description Gets a specified code scanning analysis for a repository.
- * You must use an access token with the `security_events` scope to use this endpoint with private repos,
- * the `public_repo` scope also grants permission to read security events on public repos only.
*
* The default JSON response contains fields that describe the analysis.
* This includes the Git reference and commit SHA to which the analysis relates,
@@ -7672,20 +8055,18 @@ export type paths = {
* For very old analyses this data is not available,
* and `0` is returned in this field.
*
- * If you use the Accept header `application/sarif+json`,
- * the response contains the analysis data that was uploaded.
- * This is formatted as
- * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/get-analysis"];
readonly put?: never;
readonly post?: never;
/**
* Delete a code scanning analysis from a repository
- * @description Deletes a specified code scanning analysis from a repository. For
- * private repositories, you must use an access token with the `repo` scope. For public repositories,
- * you must use an access token with `public_repo` scope.
- * GitHub Apps must have the `security_events` write permission to use this endpoint.
+ * @description Deletes a specified code scanning analysis from a repository.
*
* You can delete one analysis at a time.
* To delete a series of analyses, start with the most recent analysis and work backwards.
@@ -7747,6 +8128,8 @@ export type paths = {
* * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.
*
* The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly delete: operations["code-scanning/delete-analysis"];
readonly options?: never;
@@ -7765,8 +8148,7 @@ export type paths = {
* List CodeQL databases for a repository
* @description Lists the CodeQL databases that are available in a repository.
*
- * For private repositories, you must use an access token with the `security_events` scope.
- * For public repositories, you can use tokens with the `security_events` or `public_repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/list-codeql-databases"];
readonly put?: never;
@@ -7794,8 +8176,7 @@ export type paths = {
* your HTTP client is configured to follow redirects or use the `Location` header
* to make a second request to get the redirect URL.
*
- * For private repositories, you must use an access token with the `security_events` scope.
- * For public repositories, you can use tokens with the `security_events` or `public_repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/get-codeql-database"];
readonly put?: never;
@@ -7816,8 +8197,8 @@ export type paths = {
/**
* Get a code scanning default setup configuration
* @description Gets a code scanning default setup configuration.
- * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo`
- * scope for public repos.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/get-default-setup"];
readonly put?: never;
@@ -7828,8 +8209,8 @@ export type paths = {
/**
* Update a code scanning default setup configuration
* @description Updates a code scanning default setup configuration.
- * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo`
- * scope for public repos.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly patch: operations["code-scanning/update-default-setup"];
readonly trace?: never;
@@ -7845,7 +8226,7 @@ export type paths = {
readonly put?: never;
/**
* 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. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)."
+ * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. 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)."
@@ -7856,7 +8237,7 @@ export type paths = {
* ```
* gzip -c analysis-data.sarif | base64 -w0
* ```
- *
+ *
* 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)."
*
@@ -7875,6 +8256,8 @@ export type paths = {
* The `202 Accepted` response includes an `id` value.
* You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.
* For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly post: operations["code-scanning/upload-sarif"];
readonly delete?: never;
@@ -7892,7 +8275,8 @@ export type paths = {
};
/**
* Get information about a SARIF upload
- * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only.
+ * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)."
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/get-sarif"];
readonly put?: never;
@@ -7938,9 +8322,7 @@ export type paths = {
* List codespaces in a repository for the authenticated user
* @description Lists the codespaces associated to a specified repository and the authenticated user.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-in-repository-for-authenticated-user"];
readonly put?: never;
@@ -7948,9 +8330,7 @@ export type paths = {
* Create a codespace in a repository
* @description Creates a codespace owned by the authenticated user in the specified repository.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/create-with-repo-for-authenticated-user"];
readonly delete?: never;
@@ -7971,9 +8351,7 @@ export type paths = {
* @description Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files
* specify launchpoint configurations for codespaces created within the repository.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-devcontainers-in-repository-for-authenticated-user"];
readonly put?: never;
@@ -7995,9 +8373,7 @@ export type paths = {
* List available machine types for a repository
* @description List the machine types available for a given repository based on its configuration.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/repo-machines-for-authenticated-user"];
readonly put?: never;
@@ -8019,9 +8395,7 @@ export type paths = {
* Get default attributes for a codespace
* @description Gets the default attributes for codespaces created by the user with the repository.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"];
readonly put?: never;
@@ -8043,9 +8417,7 @@ export type paths = {
* Check if permissions defined by a devcontainer have been accepted by the authenticated user
* @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/check-permissions-for-devcontainer"];
readonly put?: never;
@@ -8065,7 +8437,10 @@ export type paths = {
};
/**
* List repository secrets
- * @description Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
+ * @description Lists all development environment secrets available in a repository without revealing their encrypted
+ * values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-repo-secrets"];
readonly put?: never;
@@ -8085,7 +8460,12 @@ export type paths = {
};
/**
* Get a repository public key
- * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-repo-public-key"];
readonly put?: never;
@@ -8105,7 +8485,9 @@ export type paths = {
};
/**
* Get a repository secret
- * @description Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
+ * @description Gets a single repository development environment secret without revealing its encrypted value.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-repo-secret"];
/**
@@ -8113,15 +8495,15 @@ export type paths = {
* @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access
- * token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets`
- * repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["codespaces/create-or-update-repo-secret"];
readonly post?: never;
/**
* Delete a repository secret
- * @description Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
+ * @description Deletes a development environment secret in a repository using the secret name.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["codespaces/delete-repo-secret"];
readonly options?: never;
@@ -8143,9 +8525,9 @@ export type paths = {
*
* Team members will include the members of child teams.
*
- * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this
- * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this
- * endpoint.
+ * The authenticated user must have push access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.
*/
readonly get: operations["repos/list-collaborators"];
readonly put?: never;
@@ -8169,9 +8551,9 @@ export type paths = {
*
* Team members will include the members of child teams.
*
- * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this
- * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this
- * endpoint.
+ * The authenticated user must have push access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.
*/
readonly get: operations["repos/check-collaborator"];
/**
@@ -8186,7 +8568,7 @@ export type paths = {
* Cannot assign {member} permission of {role name}
* ```
*
- * 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)."
+ * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*
* 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).
*
@@ -8265,9 +8647,14 @@ export type paths = {
};
/**
* List commit comments for a repository
- * @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/).
+ * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
*
- * Comments are ordered by ascending ID.
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["repos/list-commit-comments-for-repo"];
readonly put?: never;
@@ -8285,7 +8672,17 @@ export type paths = {
readonly path?: never;
readonly cookie?: never;
};
- /** Get a commit comment */
+ /**
+ * Get a commit comment
+ * @description Gets a specified commit comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
readonly get: operations["repos/get-commit-comment"];
readonly put?: never;
readonly post?: never;
@@ -8293,7 +8690,17 @@ export type paths = {
readonly delete: operations["repos/delete-commit-comment"];
readonly options?: never;
readonly head?: never;
- /** Update a commit comment */
+ /**
+ * Update a commit comment
+ * @description Updates the contents of a specified commit comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
readonly patch: operations["repos/update-commit-comment"];
readonly trace?: never;
};
@@ -8421,7 +8828,14 @@ export type paths = {
};
/**
* List commit comments
- * @description Use the `:commit_sha` to specify the commit that will have its comments listed.
+ * @description Lists the comments for a specified commit.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["repos/list-comments-for-commit"];
readonly put?: never;
@@ -8430,6 +8844,13 @@ export type paths = {
* @description Create a comment for a commit using its `:commit_sha`.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["repos/create-commit-comment"];
readonly delete?: never;
@@ -8471,11 +8892,13 @@ export type paths = {
* Get a commit
* @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
*
- * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
+ * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
*
- * You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types.
*
- * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
+ * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
+ * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.
+ * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
*
* **Signature verification object**
*
@@ -8524,11 +8947,13 @@ export type paths = {
};
/**
* List check runs for a Git reference
- * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.
+ * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.
*
* **Note:** The endpoints to manage checks only look 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.
*
* If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
readonly get: operations["checks/list-for-ref"];
readonly put?: never;
@@ -8548,9 +8973,11 @@ export type paths = {
};
/**
* List check suites for a Git reference
- * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.
+ * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.
*
* **Note:** The endpoints to manage checks only look 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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
readonly get: operations["checks/list-suites-for-ref"];
readonly put?: never;
@@ -8649,9 +9076,14 @@ export type paths = {
};
/**
* Compare two commits
- * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)."
+ * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)."
+ *
+ * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
*
- * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
+ * - **`application/vnd.github.diff`**: Returns the diff of the commit.
+ * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.
*
* The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.
*
@@ -8713,50 +9145,40 @@ export type paths = {
};
/**
* Get repository content
- * @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.
+ * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.
+ * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
+ * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.
+ *
+ * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule".
*
- * 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/overview/media-types) to ensure the content is returned in a consistent
- * object format.
+ * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.
+ *
+ * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values.
*
* **Notes**:
- * * 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.
- * Size limits:
- * If the requested file's size is:
- * * 1 MB or smaller: All features of this endpoint are supported.
- * * Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type.
- * * Greater than 100 MB: This endpoint is not supported.
- *
- * If the content is a directory:
- * The response will be an array of objects, one object for each item in the directory.
- * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value
- * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).
- * In the next major version of the API, the type will be returned as "submodule".
- *
- * If the content is a symlink:
- * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the
- * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object
- * describing the symlink itself.
- *
- * If the content is a submodule:
- * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific
- * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out
- * the submodule at that specific commit.
- *
- * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the
- * github.com URLs (`html_url` and `_links["html"]`) will have null values.
+ *
+ * - 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.
+ * - If the requested file's size is:
+ * - 1 MB or smaller: All features of this endpoint are supported.
+ * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty
+ * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type.
+ * - Greater than 100 MB: This endpoint is not supported.
*/
readonly get: operations["repos/get-content"];
/**
* 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 `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope.
+ * @description Creates a new file or replaces an existing file in a repository.
*
* **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.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.
*/
readonly put: operations["repos/create-or-update-file-contents"];
readonly post?: never;
@@ -8809,9 +9231,7 @@ export type paths = {
};
/**
* List Dependabot alerts for a repository
- * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories.
- * You can also use tokens with the `public_repo` scope for public repositories only.
- * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
+ * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["dependabot/list-alerts-for-repo"];
readonly put?: never;
@@ -8831,9 +9251,7 @@ export type paths = {
};
/**
* Get a Dependabot alert
- * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories.
- * You can also use tokens with the `public_repo` scope for public repositories only.
- * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
+ * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["dependabot/get-alert"];
readonly put?: never;
@@ -8843,11 +9261,9 @@ export type paths = {
readonly head?: never;
/**
* Update a Dependabot alert
- * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories.
- * You can also use tokens with the `public_repo` scope for public repositories only.
- * GitHub Apps must have **Dependabot alerts** write permission to use this endpoint.
+ * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
*
- * To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly patch: operations["dependabot/update-alert"];
readonly trace?: never;
@@ -8861,7 +9277,10 @@ export type paths = {
};
/**
* List repository secrets
- * @description Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
+ * @description Lists all secrets available in a repository without revealing their encrypted
+ * values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["dependabot/list-repo-secrets"];
readonly put?: never;
@@ -8881,7 +9300,11 @@ export type paths = {
};
/**
* Get a repository public key
- * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets. Anyone with read access
+ * to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private.
*/
readonly get: operations["dependabot/get-repo-public-key"];
readonly put?: never;
@@ -8901,7 +9324,9 @@ export type paths = {
};
/**
* Get a repository secret
- * @description Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
+ * @description Gets a single repository secret without revealing its encrypted value.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["dependabot/get-repo-secret"];
/**
@@ -8909,15 +9334,15 @@ export type paths = {
* @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access
- * token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository
- * permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["dependabot/create-or-update-repo-secret"];
readonly post?: never;
/**
* Delete a repository secret
- * @description Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
+ * @description Deletes a secret in a repository using the secret name.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["dependabot/delete-repo-secret"];
readonly options?: never;
@@ -8976,7 +9401,11 @@ export type paths = {
readonly put?: never;
/**
* Create a snapshot of dependencies for a repository
- * @description Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to.
+ * @description Create a new snapshot of a repository's dependencies.
+ *
+ * The authenticated user must have access to the repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["dependency-graph/create-repository-snapshot"];
readonly delete?: never;
@@ -9026,8 +9455,6 @@ export type paths = {
* be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an
* application with debugging enabled.
*
- * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref.
- *
* Merged branch response:
*
* You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
@@ -9048,6 +9475,8 @@ export type paths = {
*
* This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`
* status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.
*/
readonly post: operations["repos/create-deployment"];
readonly delete?: never;
@@ -9069,7 +9498,7 @@ export type paths = {
readonly post?: never;
/**
* Delete a deployment
- * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment.
+ * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.
*
* To set a deployment as inactive, you must:
*
@@ -9077,6 +9506,8 @@ export type paths = {
* * Mark the active deployment as inactive by adding any non-successful deployment status.
*
* For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.
*/
readonly delete: operations["repos/delete-deployment"];
readonly options?: never;
@@ -9101,7 +9532,7 @@ export type paths = {
* Create a deployment status
* @description Users with `push` access can create deployment statuses for a given deployment.
*
- * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint.
*/
readonly post: operations["repos/create-deployment-status"];
readonly delete?: never;
@@ -9145,12 +9576,9 @@ export type paths = {
*
* The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.
*
- * This endpoint requires write access to the repository by providing either:
- *
- * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation.
- * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.
- *
* This input example shows how you can use the `client_payload` as a test to debug your workflow.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["repos/create-dispatch-event"];
readonly delete?: never;
@@ -9170,7 +9598,9 @@ export type paths = {
* List environments
* @description Lists the environments for a repository.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/get-all-environments"];
readonly put?: never;
@@ -9192,9 +9622,9 @@ export type paths = {
* Get an environment
* @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)."
*
- * Anyone with read access to the repository can use this endpoint. If the
- * repository is private, you must use an access token with the `repo` scope. GitHub
- * Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/get-environment"];
/**
@@ -9205,13 +9635,13 @@ export type paths = {
*
* **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.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["repos/create-or-update-environment"];
readonly post?: never;
/**
* Delete an environment
- * @description You must authenticate using an access token with the repo scope to use this endpoint.
+ * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["repos/delete-an-environment"];
readonly options?: never;
@@ -9230,7 +9660,9 @@ export type paths = {
* List deployment branch policies
* @description Lists the deployment branch policies for an environment.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/list-deployment-branch-policies"];
readonly put?: never;
@@ -9238,7 +9670,7 @@ export type paths = {
* Create a deployment branch policy
* @description Creates a deployment branch or tag policy for an environment.
*
- * 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.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["repos/create-deployment-branch-policy"];
readonly delete?: never;
@@ -9258,14 +9690,16 @@ export type paths = {
* Get a deployment branch policy
* @description Gets a deployment branch or tag policy for an environment.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/get-deployment-branch-policy"];
/**
* Update a deployment branch policy
* @description Updates a deployment branch or tag policy for an environment.
*
- * 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.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["repos/update-deployment-branch-policy"];
readonly post?: never;
@@ -9273,7 +9707,7 @@ export type paths = {
* Delete a deployment branch policy
* @description Deletes a deployment branch or tag policy for an environment.
*
- * 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.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["repos/delete-deployment-branch-policy"];
readonly options?: never;
@@ -9290,9 +9724,11 @@ export type paths = {
};
/**
* Get all deployment protection rules for an environment
- * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+ * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
*
* For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/get-all-deployment-protection-rules"];
readonly put?: never;
@@ -9300,9 +9736,11 @@ export type paths = {
* Create a custom deployment protection rule on an environment
* @description Enable a custom deployment protection rule for an environment.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * The authenticated user must have admin or owner permissions to the repository to use this endpoint.
*
* For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["repos/create-deployment-protection-rule"];
readonly delete?: never;
@@ -9320,11 +9758,13 @@ export type paths = {
};
/**
* List custom deployment rule integrations available for an environment
- * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint.
+ * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint.
*
- * For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+ * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
*
* For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)".
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/list-custom-deployment-rule-integrations"];
readonly put?: never;
@@ -9344,9 +9784,11 @@ export type paths = {
};
/**
* Get a custom deployment protection rule
- * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+ * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
*
* For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/get-custom-deployment-protection-rule"];
readonly put?: never;
@@ -9355,7 +9797,9 @@ export type paths = {
* Disable a custom protection rule for an environment
* @description Disables a custom deployment protection rule for an environment.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)".
+ * The authenticated user must have admin or owner permissions to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["repos/disable-deployment-protection-rule"];
readonly options?: never;
@@ -9363,6 +9807,169 @@ export type paths = {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * List environment secrets
+ * @description Lists all secrets available in an environment without revealing their
+ * encrypted values.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly get: operations["actions/list-environment-secrets"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get an environment public key
+ * @description Get the public key for an environment, which you need to encrypt environment
+ * secrets. You need to encrypt a secret before you can create or update secrets.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly get: operations["actions/get-environment-public-key"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get an environment secret
+ * @description Gets a single environment secret without revealing its encrypted value.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly get: operations["actions/get-environment-secret"];
+ /**
+ * Create or update an environment secret
+ * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly put: operations["actions/create-or-update-environment-secret"];
+ readonly post?: never;
+ /**
+ * Delete an environment secret
+ * @description Deletes a secret in an environment using the secret name.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly delete: operations["actions/delete-environment-secret"];
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/repos/{owner}/{repo}/environments/{environment_name}/variables": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * List environment variables
+ * @description Lists all environment variables.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly get: operations["actions/list-environment-variables"];
+ readonly put?: never;
+ /**
+ * Create an environment variable
+ * @description Create an environment variable that you can reference in a GitHub Actions workflow.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly post: operations["actions/create-environment-variable"];
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get an environment variable
+ * @description Gets a specific variable in an environment.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly get: operations["actions/get-environment-variable"];
+ readonly put?: never;
+ readonly post?: never;
+ /**
+ * Delete an environment variable
+ * @description Deletes an environment variable using the variable name.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly delete: operations["actions/delete-environment-variable"];
+ readonly options?: never;
+ readonly head?: never;
+ /**
+ * Update an environment variable
+ * @description Updates an environment variable that you can reference in a GitHub Actions workflow.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly patch: operations["actions/update-environment-variable"];
+ readonly trace?: never;
+ };
readonly "/repos/{owner}/{repo}/events": {
readonly parameters: {
readonly query?: never;
@@ -9437,7 +10044,12 @@ export type paths = {
* Get a blob
* @description The `content` in the response will always be Base64 encoded.
*
- * _Note_: This API supports blobs up to 100 megabytes in size.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw blob data.
+ * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.
+ *
+ * **Note** This endpoint supports blobs up to 100 megabytes in size.
*/
readonly get: operations["git/get-blob"];
readonly put?: never;
@@ -9626,11 +10238,17 @@ export type paths = {
readonly get?: never;
readonly put?: never;
readonly post?: never;
- /** Delete a reference */
+ /**
+ * Delete a reference
+ * @description Deletes the provided reference.
+ */
readonly delete: operations["git/delete-ref"];
readonly options?: never;
readonly head?: never;
- /** Update a reference */
+ /**
+ * Update a reference
+ * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
+ */
readonly patch: operations["git/update-ref"];
readonly trace?: never;
};
@@ -9840,7 +10458,7 @@ export type paths = {
* 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/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.
+ * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.
*/
readonly get: operations["repos/get-webhook-config-for-repo"];
readonly put?: never;
@@ -9852,7 +10470,7 @@ export type paths = {
* 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/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.
+ * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.
*/
readonly patch: operations["repos/update-webhook-config-for-repo"];
readonly trace?: never;
@@ -10250,6 +10868,13 @@ export type paths = {
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/list-for-repo"];
readonly put?: never;
@@ -10259,6 +10884,13 @@ export type paths = {
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
* and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["issues/create"];
readonly delete?: never;
@@ -10279,6 +10911,13 @@ export type paths = {
* @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.
*
* By default, issue comments are ordered by ascending ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/list-comments-for-repo"];
readonly put?: never;
@@ -10299,6 +10938,13 @@ export type paths = {
/**
* Get an issue comment
* @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/get-comment"];
readonly put?: never;
@@ -10313,6 +10959,13 @@ export type paths = {
/**
* Update an issue comment
* @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly patch: operations["issues/update-comment"];
readonly trace?: never;
@@ -10412,7 +11065,7 @@ export type paths = {
};
/**
* Get an issue
- * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was
+ * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was
* [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If
* the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
* returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read
@@ -10423,6 +11076,13 @@ export type paths = {
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/get"];
readonly put?: never;
@@ -10433,6 +11093,13 @@ export type paths = {
/**
* Update an issue
* @description Issue owners and users with push access can edit an issue.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly patch: operations["issues/update"];
readonly trace?: never;
@@ -10497,18 +11164,31 @@ export type paths = {
* @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
*
* Issue comments are ordered by ascending ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/list-comments"];
readonly put?: never;
/**
* Create an issue comment
- * @description
- * You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
*
* 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.
* For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
* and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["issues/create-comment"];
readonly delete?: never;
@@ -10601,7 +11281,7 @@ export type paths = {
* Lock an issue
* @description Users with push access can lock an issue or pull request's conversation.
*
- * 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)."
+ * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
readonly put: operations["issues/lock"];
readonly post?: never;
@@ -10806,7 +11486,10 @@ export type paths = {
* Get the license for a repository
* @description This method returns the contents of the repository's license file, if one is detected.
*
- * Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license.
+ * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
*/
readonly get: operations["licenses/get-for-repo"];
readonly put?: never;
@@ -10958,28 +11641,34 @@ export type paths = {
* Get a GitHub Pages site
* @description Gets information about a GitHub Pages site.
*
- * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["repos/get-pages"];
/**
* Update information about a GitHub Pages site
* @description Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
*
- * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["repos/update-information-about-pages-site"];
/**
* Create a GitHub Pages site
* @description Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."
*
- * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["repos/create-pages-site"];
/**
* Delete a GitHub Pages site
* @description Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
*
- * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["repos/delete-pages-site"];
readonly options?: never;
@@ -10998,7 +11687,7 @@ export type paths = {
* List GitHub Pages builds
* @description Lists builts of a GitHub Pages site.
*
- * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["repos/list-pages-builds"];
readonly put?: never;
@@ -11026,7 +11715,7 @@ export type paths = {
* Get latest Pages build
* @description Gets information about the single most recent build of a GitHub Pages site.
*
- * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["repos/get-latest-pages-build"];
readonly put?: never;
@@ -11048,7 +11737,7 @@ export type paths = {
* Get GitHub Pages build
* @description Gets information about a GitHub Pages build.
*
- * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["repos/get-pages-build"];
readonly put?: never;
@@ -11059,7 +11748,7 @@ export type paths = {
readonly patch?: never;
readonly trace?: never;
};
- readonly "/repos/{owner}/{repo}/pages/deployment": {
+ readonly "/repos/{owner}/{repo}/pages/deployments": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
@@ -11072,7 +11761,7 @@ export type paths = {
* Create a GitHub Pages deployment
* @description Create a GitHub Pages deployment for a repository.
*
- * Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint.
+ * The authenticated user must have write permission to the repository.
*/
readonly post: operations["repos/create-pages-deployment"];
readonly delete?: never;
@@ -11081,6 +11770,50 @@ export type paths = {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get the status of a GitHub Pages deployment
+ * @description Gets the current status of a GitHub Pages deployment.
+ *
+ * The authenticated user must have read permission for the GitHub Pages site.
+ */
+ readonly get: operations["repos/get-pages-deployment"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ readonly get?: never;
+ readonly put?: never;
+ /**
+ * Cancel a GitHub Pages deployment
+ * @description Cancels a GitHub Pages deployment.
+ *
+ * The authenticated user must have write permissions for the GitHub Pages site.
+ */
+ readonly post: operations["repos/cancel-pages-deployment"];
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/repos/{owner}/{repo}/pages/health": {
readonly parameters: {
readonly query?: never;
@@ -11094,7 +11827,9 @@ export type paths = {
*
* The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.
*
- * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions.
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["repos/get-pages-health-check"];
readonly put?: never;
@@ -11112,7 +11847,11 @@ export type paths = {
readonly path?: never;
readonly cookie?: never;
};
- readonly get?: never;
+ /**
+ * Check if private vulnerability reporting is enabled for a repository
+ * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)".
+ */
+ readonly get: operations["repos/check-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)."
@@ -11171,7 +11910,14 @@ export type paths = {
readonly delete?: never;
readonly options?: never;
readonly head?: never;
- readonly patch?: never;
+ /**
+ * Create or update custom property values for a repository
+ * @description Create new or update existing custom property values for a repository.
+ * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.
+ *
+ * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint.
+ */
+ readonly patch: operations["repos/create-or-update-custom-properties-values"];
readonly trace?: never;
};
readonly "/repos/{owner}/{repo}/pulls": {
@@ -11183,7 +11929,20 @@ export type paths = {
};
/**
* List pull requests
- * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * @description Lists pull requests in a specified repository.
+ *
+ * Draft pull requests are available in public repositories with GitHub
+ * Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing
+ * plans, and in public and private repositories with GitHub Team and GitHub Enterprise
+ * Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)
+ * in the GitHub Help documentation.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list"];
readonly put?: never;
@@ -11194,6 +11953,13 @@ export type paths = {
* To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["pulls/create"];
readonly delete?: never;
@@ -11211,7 +11977,15 @@ export type paths = {
};
/**
* List review comments in a repository
- * @description Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
+ * @description Lists review comments for all pull requests in a repository. By default,
+ * review comments are in ascending order by ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list-review-comments-for-repo"];
readonly put?: never;
@@ -11231,7 +12005,14 @@ export type paths = {
};
/**
* Get a review comment for a pull request
- * @description Provides details for a review comment.
+ * @description Provides details for a specified review comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/get-review-comment"];
readonly put?: never;
@@ -11245,7 +12026,14 @@ export type paths = {
readonly head?: never;
/**
* Update a review comment for a pull request
- * @description Enables you to edit a review comment.
+ * @description Edits the content of a specified review comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly patch: operations["pulls/update-review-comment"];
readonly trace?: never;
@@ -11320,6 +12108,14 @@ export type paths = {
* * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.
*
* Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
*/
readonly get: operations["pulls/get"];
readonly put?: never;
@@ -11332,6 +12128,13 @@ export type paths = {
* @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly patch: operations["pulls/update"];
readonly trace?: never;
@@ -11349,9 +12152,7 @@ export type paths = {
* Create a codespace from a pull request
* @description Creates a codespace owned by the authenticated user for the specified pull request.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/create-with-pr-for-authenticated-user"];
readonly delete?: never;
@@ -11369,21 +12170,35 @@ export type paths = {
};
/**
* List review comments on a pull request
- * @description Lists all review comments for a pull request. By default, review comments are in ascending order by ID.
+ * @description Lists all review comments for a specified pull request. By default, review comments
+ * are in ascending order by ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list-review-comments"];
readonly put?: never;
/**
* Create a review comment for a pull request
- * @description
- * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.
+ * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)."
*
- * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.
+ * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.
*
- * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
+ * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
* and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["pulls/create-review-comment"];
readonly delete?: never;
@@ -11407,6 +12222,13 @@ export type paths = {
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
* and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["pulls/create-reply-for-review-comment"];
readonly delete?: never;
@@ -11424,7 +12246,16 @@ export type paths = {
};
/**
* 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/commits/commits#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.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list-commits"];
readonly put?: never;
@@ -11444,7 +12275,17 @@ export type paths = {
};
/**
* List pull requests files
- * @description **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
+ * @description Lists the files in a specified pull request.
+ *
+ * **Note:** Responses include a maximum of 3000 files. The paginated response
+ * returns 30 files per page by default.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list-files"];
readonly put?: never;
@@ -11518,19 +12359,35 @@ export type paths = {
};
/**
* List reviews for a pull request
- * @description The list of reviews returns in chronological order.
+ * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list-reviews"];
readonly put?: never;
/**
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ * @description Creates a review on a specified pull request.
+ *
+ * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
*
* 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.
+ * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.
*
* The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["pulls/create-review"];
readonly delete?: never;
@@ -11549,17 +12406,38 @@ export type paths = {
/**
* Get a review for a pull request
* @description Retrieves a pull request review by its ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/get-review"];
/**
* Update a review for a pull request
- * @description Update the review summary comment with new text.
+ * @description Updates the contents of a specified review summary comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly put: operations["pulls/update-review"];
readonly post?: never;
/**
* Delete a pending review for a pull request
* @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly delete: operations["pulls/delete-pending-review"];
readonly options?: never;
@@ -11576,7 +12454,14 @@ export type paths = {
};
/**
* List comments for a pull request review
- * @description List comments for a specific pull request review.
+ * @description Lists comments for a specific pull request review.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list-comments-for-review"];
readonly put?: never;
@@ -11597,7 +12482,18 @@ export type paths = {
readonly get?: never;
/**
* Dismiss a review for a pull request
- * @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.
+ * @description Dismisses a specified review on a pull request.
+ *
+ * **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.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly put: operations["pulls/dismiss-review"];
readonly post?: never;
@@ -11619,6 +12515,13 @@ export type paths = {
/**
* 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/reviews#create-a-review-for-a-pull-request)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["pulls/submit-review"];
readonly delete?: never;
@@ -11658,7 +12561,10 @@ export type paths = {
* Get a repository README
* @description Gets the preferred README for a repository.
*
- * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
+ * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
*/
readonly get: operations["repos/get-readme"];
readonly put?: never;
@@ -11680,7 +12586,10 @@ export type 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/overview/media-types) for retrieving the raw content or rendered HTML.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
+ * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
*/
readonly get: operations["repos/get-readme-in-directory"];
readonly put?: never;
@@ -11815,7 +12724,11 @@ export type paths = {
};
/**
* Get a release
- * @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia).
+ * @description Gets a public release with the specified release ID.
+ *
+ * **Note:** This returns an `upload_url` key corresponding to the endpoint
+ * for uploading release assets. This key is a hypermedia resource. For more information, see
+ * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."
*/
readonly get: operations["repos/get-release"];
readonly put?: never;
@@ -11846,7 +12759,7 @@ export type paths = {
readonly put?: never;
/**
* Upload a release asset
- * @description This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
+ * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
* the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.
*
* You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.
@@ -12046,10 +12959,10 @@ export type paths = {
/**
* List secret scanning alerts for a repository
* @description Lists secret scanning alerts for an eligible repository, from newest to oldest.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["secret-scanning/list-alerts-for-repo"];
readonly put?: never;
@@ -12070,10 +12983,10 @@ export type paths = {
/**
* Get a secret scanning alert
* @description Gets a single secret scanning alert detected in an eligible repository.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["secret-scanning/get-alert"];
readonly put?: never;
@@ -12084,10 +12997,10 @@ export type paths = {
/**
* Update a secret scanning alert
* @description Updates the status of a secret scanning alert in an eligible repository.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
*
- * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly patch: operations["secret-scanning/update-alert"];
readonly trace?: never;
@@ -12102,10 +13015,10 @@ export type paths = {
/**
* List locations for a secret scanning alert
* @description Lists all locations for a given secret scanning alert for an eligible repository.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["secret-scanning/list-locations-for-alert"];
readonly put?: never;
@@ -12126,19 +13039,20 @@ export type paths = {
/**
* List repository security advisories
* @description Lists security advisories in a repository.
- * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission
- * in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to.
*
- * You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory.
+ * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
*/
readonly get: operations["security-advisories/list-repository-advisories"];
readonly put?: never;
/**
* Create a repository security advisory
* @description Creates a new repository security advisory.
- * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.
*
- * In order to create a draft repository security advisory, you must be a security manager or administrator of that repository.
+ * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
*/
readonly post: operations["security-advisories/create-repository-advisory"];
readonly delete?: never;
@@ -12178,12 +13092,13 @@ export type paths = {
/**
* Get a repository security advisory
* @description Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
- * You can access any published security advisory on a public repository.
- * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission
- * in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to.
*
- * You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a
+ * Anyone can access any published security advisory on a public repository.
+ *
+ * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a
* collaborator on the security advisory.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
*/
readonly get: operations["security-advisories/get-repository-advisory"];
readonly put?: never;
@@ -12194,10 +13109,11 @@ export type paths = {
/**
* Update a repository security advisory
* @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
- * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.
*
- * In order to update any security advisory, you must be a security manager or administrator of that repository,
+ * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository,
* or a collaborator on the repository security advisory.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
*/
readonly patch: operations["security-advisories/update-repository-advisory"];
readonly trace?: never;
@@ -12217,9 +13133,9 @@ export type paths = {
*
* 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, the authenticated user must be a security manager or administrator of that repository.
*
- * In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
*/
readonly post: operations["security-advisories/create-repository-advisory-cve-request"];
readonly delete?: never;
@@ -12228,6 +13144,28 @@ export type paths = {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ readonly get?: never;
+ readonly put?: never;
+ /**
+ * Create a temporary private fork
+ * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.
+ *
+ * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.
+ */
+ readonly post: operations["security-advisories/create-fork"];
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/repos/{owner}/{repo}/stargazers": {
readonly parameters: {
readonly query?: never;
@@ -12239,7 +13177,9 @@ export type paths = {
* List stargazers
* @description Lists the people that have starred the repository.
*
- * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
*/
readonly get: operations["activity/list-stargazers-for-repo"];
readonly put?: never;
@@ -12259,7 +13199,12 @@ export type paths = {
};
/**
* Get the weekly commit activity
- * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
+ * @description
+ * Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
+ *
+ * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains
+ * 10,000 or more commits, a 422 status code will be returned.
+ *
*/
readonly get: operations["repos/get-code-frequency-stats"];
readonly put?: never;
@@ -12302,10 +13247,12 @@ export type paths = {
* @description
* Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:
*
- * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).
+ * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).
* * `a` - Number of additions
* * `d` - Number of deletions
* * `c` - Number of commits
+ *
+ * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.
*/
readonly get: operations["repos/get-contributors-stats"];
readonly put?: never;
@@ -12537,11 +13484,7 @@ export type paths = {
*
* For a public repository, a team is listed only if that team added the public repository explicitly.
*
- * Personal access tokens require the following scopes:
- * * `public_repo` to call this endpoint on a public repository
- * * `repo` to call this endpoint on a private repository (this scope also includes public repositories)
- *
- * This endpoint is not compatible with fine-grained personal access tokens.
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/list-teams"];
readonly put?: never;
@@ -12662,7 +13605,6 @@ export type paths = {
/**
* Transfer a repository
* @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).
- * You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account.
*/
readonly post: operations["repos/transfer"];
readonly delete?: never;
@@ -12738,12 +13680,7 @@ export type paths = {
* Create a repository using a template
* @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
*
- * **OAuth scope requirements**
- *
- * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
- *
- * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- * * `repo` scope to create a private repository
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
*/
readonly post: operations["repos/create-using-template"];
readonly delete?: never;
@@ -12776,170 +13713,6 @@ export type paths = {
readonly patch?: never;
readonly trace?: never;
};
- readonly "/repositories/{repository_id}/environments/{environment_name}/secrets": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
- };
- /**
- * List environment secrets
- * @description Lists all secrets available in an environment without revealing their
- * encrypted values.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
- */
- readonly get: operations["actions/list-environment-secrets"];
- readonly put?: never;
- readonly post?: never;
- readonly delete?: never;
- readonly options?: never;
- readonly head?: never;
- readonly patch?: never;
- readonly trace?: never;
- };
- readonly "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
- };
- /**
- * Get an environment public key
- * @description Get the public key for an environment, which you need to encrypt environment
- * secrets. You need to encrypt a secret before you can create or update secrets.
- *
- * Anyone with read access to the repository can use this endpoint.
- * If the repository is private you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
- */
- readonly get: operations["actions/get-environment-public-key"];
- readonly put?: never;
- readonly post?: never;
- readonly delete?: never;
- readonly options?: never;
- readonly head?: never;
- readonly patch?: never;
- readonly trace?: never;
- };
- readonly "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
- };
- /**
- * Get an environment secret
- * @description Gets a single environment secret without revealing its encrypted value.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
- */
- readonly get: operations["actions/get-environment-secret"];
- /**
- * Create or update an environment secret
- * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
- */
- readonly put: operations["actions/create-or-update-environment-secret"];
- readonly post?: never;
- /**
- * Delete an environment secret
- * @description Deletes a secret in an environment using the secret name.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
- */
- readonly delete: operations["actions/delete-environment-secret"];
- readonly options?: never;
- readonly head?: never;
- readonly patch?: never;
- readonly trace?: never;
- };
- readonly "/repositories/{repository_id}/environments/{environment_name}/variables": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
- };
- /**
- * List environment variables
- * @description Lists all environment variables.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `environments:read` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
- */
- readonly get: operations["actions/list-environment-variables"];
- readonly put?: never;
- /**
- * Create an environment variable
- * @description Create an environment variable that you can reference in a GitHub Actions workflow.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `environment:write` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
- */
- readonly post: operations["actions/create-environment-variable"];
- readonly delete?: never;
- readonly options?: never;
- readonly head?: never;
- readonly patch?: never;
- readonly trace?: never;
- };
- readonly "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
- };
- /**
- * Get an environment variable
- * @description Gets a specific variable in an environment.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `environments:read` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
- */
- readonly get: operations["actions/get-environment-variable"];
- readonly put?: never;
- readonly post?: never;
- /**
- * Delete an environment variable
- * @description Deletes an environment variable using the variable name.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `environment:write` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
- */
- readonly delete: operations["actions/delete-environment-variable"];
- readonly options?: never;
- readonly head?: never;
- /**
- * Update an environment variable
- * @description Updates an environment variable that you can reference in a GitHub Actions workflow.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `environment:write` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
- */
- readonly patch: operations["actions/update-environment-variable"];
- readonly trace?: never;
- };
readonly "/search/code": {
readonly parameters: {
readonly query?: never;
@@ -13202,7 +13975,9 @@ export type 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 discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.
*
- * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List all discussions on a team's page.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/list-discussions-legacy"];
readonly put?: never;
@@ -13211,9 +13986,11 @@ export type 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 a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.
*
- * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Creates a new discussion post on a team's page.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["teams/create-discussion-legacy"];
readonly delete?: never;
@@ -13234,7 +14011,9 @@ export type 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 [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.
*
- * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Get a specific discussion on a team's page.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/get-discussion-legacy"];
readonly put?: never;
@@ -13244,7 +14023,9 @@ export type 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 [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.
*
- * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Delete a discussion from a team's page.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly delete: operations["teams/delete-discussion-legacy"];
readonly options?: never;
@@ -13254,7 +14035,9 @@ export type 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 [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.
*
- * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Edits the title and body text of a discussion post. Only the parameters you provide are updated.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly patch: operations["teams/update-discussion-legacy"];
readonly trace?: never;
@@ -13271,7 +14054,9 @@ export type 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 discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.
*
- * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List all comments on a team discussion.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/list-discussion-comments-legacy"];
readonly put?: never;
@@ -13280,9 +14065,11 @@ export type 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 a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
*
- * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Creates a new comment on a team discussion.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["teams/create-discussion-comment-legacy"];
readonly delete?: never;
@@ -13303,7 +14090,9 @@ export type 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 [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
*
- * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Get a specific comment on a team discussion.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/get-discussion-comment-legacy"];
readonly put?: never;
@@ -13313,7 +14102,9 @@ export type 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 [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
*
- * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Deletes a comment on a team discussion.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly delete: operations["teams/delete-discussion-comment-legacy"];
readonly options?: never;
@@ -13323,7 +14114,9 @@ export type 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 [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
*
- * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Edits the body text of a discussion comment.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly patch: operations["teams/update-discussion-comment-legacy"];
readonly trace?: never;
@@ -13340,7 +14133,9 @@ export type 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/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/).
+ * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["reactions/list-for-team-discussion-comment-legacy"];
readonly put?: never;
@@ -13349,7 +14144,11 @@ export type 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/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.
+ * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["reactions/create-for-team-discussion-comment-legacy"];
readonly delete?: never;
@@ -13370,7 +14169,9 @@ export type 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/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/).
+ * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["reactions/list-for-team-discussion-legacy"];
readonly put?: never;
@@ -13379,7 +14180,11 @@ export type 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/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.
+ * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
+ *
+ * A response with an HTTP `200` status means that you already added the reaction type to this team discussion.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["reactions/create-for-team-discussion-legacy"];
readonly delete?: never;
@@ -13464,7 +14269,7 @@ export type paths = {
*
* **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
*
- * Note that 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)."
+ * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
readonly put: operations["teams/add-member-legacy"];
readonly post?: never;
@@ -13648,7 +14453,7 @@ export type paths = {
*
* 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.
*
- * 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)."
+ * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
readonly put: operations["teams/add-or-update-repo-permissions-legacy"];
readonly post?: never;
@@ -13695,9 +14500,7 @@ export type paths = {
};
/**
* Get the authenticated user
- * @description If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information.
- *
- * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information.
+ * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information.
*/
readonly get: operations["users/get-authenticated"];
readonly put?: never;
@@ -13771,9 +14574,7 @@ export type paths = {
* List codespaces for the authenticated user
* @description Lists the authenticated user's codespaces.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-for-authenticated-user"];
readonly put?: never;
@@ -13783,9 +14584,7 @@ export type paths = {
*
* This endpoint requires either a `repository_id` OR a `pull_request` but not both.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/create-for-authenticated-user"];
readonly delete?: never;
@@ -13806,9 +14605,9 @@ export type paths = {
* @description Lists all development environment secrets available for a user's codespaces without revealing their
* encrypted values.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-secrets-for-authenticated-user"];
readonly put?: never;
@@ -13830,9 +14629,9 @@ export type paths = {
* Get public key for the authenticated user
* @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-public-key-for-authenticated-user"];
readonly put?: never;
@@ -13854,9 +14653,9 @@ export type paths = {
* Get a secret for the authenticated user
* @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-secret-for-authenticated-user"];
/**
@@ -13864,9 +14663,9 @@ export type paths = {
* @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly put: operations["codespaces/create-or-update-secret-for-authenticated-user"];
readonly post?: never;
@@ -13874,9 +14673,9 @@ export type paths = {
* Delete a secret for the authenticated user
* @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly delete: operations["codespaces/delete-secret-for-authenticated-user"];
readonly options?: never;
@@ -13895,18 +14694,18 @@ export type paths = {
* List selected repositories for a user secret
* @description List the repositories that have been granted the ability to use a user's development environment secret.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"];
/**
* Set selected repositories for a user secret
* @description Select the repositories that will use a user's development environment secret.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"];
readonly post?: never;
@@ -13927,16 +14726,20 @@ export type paths = {
/**
* Add a selected repository to a user secret
* @description Adds a repository to the selected repositories for a user's development environment secret.
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint.
+ *
+ * The authenticated user must have Codespaces access to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly put: operations["codespaces/add-repository-for-secret-for-authenticated-user"];
readonly post?: never;
/**
* Remove a selected repository from a user secret
* @description Removes a repository from the selected repositories for a user's development environment secret.
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.
+ *
+ * The authenticated user must have Codespaces access to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"];
readonly options?: never;
@@ -13955,9 +14758,7 @@ export type paths = {
* Get a codespace for the authenticated user
* @description Gets information about a user's codespace.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-for-authenticated-user"];
readonly put?: never;
@@ -13966,9 +14767,7 @@ export type paths = {
* Delete a codespace for the authenticated user
* @description Deletes a user's codespace.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly delete: operations["codespaces/delete-for-authenticated-user"];
readonly options?: never;
@@ -13979,9 +14778,7 @@ export type paths = {
*
* If you specify a new machine type it will be applied the next time your codespace is started.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly patch: operations["codespaces/update-for-authenticated-user"];
readonly trace?: never;
@@ -14001,9 +14798,7 @@ export type paths = {
*
* If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.
*
- * You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/export-for-authenticated-user"];
readonly delete?: never;
@@ -14023,9 +14818,7 @@ export type paths = {
* Get details about a codespace export
* @description Gets information about an export of a codespace.
*
- * You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-export-details-for-authenticated-user"];
readonly put?: never;
@@ -14047,9 +14840,7 @@ export type paths = {
* List machine types for a codespace
* @description List the machine types a codespace can transition to use.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/codespace-machines-for-authenticated-user"];
readonly put?: never;
@@ -14077,9 +14868,7 @@ export type paths = {
*
* This will fail for a codespace that is already published, meaning it has an associated repository.
*
- * You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/publish-for-authenticated-user"];
readonly delete?: never;
@@ -14101,9 +14890,7 @@ export type paths = {
* Start a codespace for the authenticated user
* @description Starts a user's codespace.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/start-for-authenticated-user"];
readonly delete?: never;
@@ -14125,9 +14912,7 @@ export type paths = {
* Stop a codespace for the authenticated user
* @description Stops a user's codespace.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/stop-for-authenticated-user"];
readonly delete?: never;
@@ -14146,7 +14931,8 @@ export type paths = {
/**
* Get list of conflicting packages during Docker migration for authenticated-user
* @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
*/
readonly get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"];
readonly put?: never;
@@ -14186,18 +14972,21 @@ export type paths = {
};
/**
* List email addresses for the authenticated user
- * @description Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.
+ * @description Lists all of your email addresses, and specifies which one is visible
+ * to the public.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
*/
readonly get: operations["users/list-emails-for-authenticated-user"];
readonly put?: never;
/**
* Add an email address for the authenticated user
- * @description This endpoint is accessible with the `user` scope.
+ * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly post: operations["users/add-email-for-authenticated-user"];
/**
* Delete an email address for the authenticated user
- * @description This endpoint is accessible with the `user` scope.
+ * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly delete: operations["users/delete-email-for-authenticated-user"];
readonly options?: never;
@@ -14256,15 +15045,15 @@ export type paths = {
readonly get: operations["users/check-person-is-followed-by-authenticated"];
/**
* Follow a user
- * @description Note that 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)."
+ * @description Note that 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/guides/getting-started-with-the-rest-api#http-method)."
*
- * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
*/
readonly put: operations["users/follow"];
readonly post?: never;
/**
* Unfollow a user
- * @description Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.
+ * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
*/
readonly delete: operations["users/unfollow"];
readonly options?: never;
@@ -14281,13 +15070,17 @@ export type paths = {
};
/**
* List GPG keys for the authenticated user
- * @description Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Lists the current user's GPG keys.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
*/
readonly get: operations["users/list-gpg-keys-for-authenticated-user"];
readonly put?: never;
/**
* Create a GPG key for the authenticated user
- * @description Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Adds a GPG key to the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
*/
readonly post: operations["users/create-gpg-key-for-authenticated-user"];
readonly delete?: never;
@@ -14305,14 +15098,18 @@ export type paths = {
};
/**
* Get a GPG key for the authenticated user
- * @description View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description View extended details for a single GPG key.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
*/
readonly get: operations["users/get-gpg-key-for-authenticated-user"];
readonly put?: never;
readonly post?: never;
/**
* Delete a GPG key for the authenticated user
- * @description Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Removes a GPG key from the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.
*/
readonly delete: operations["users/delete-gpg-key-for-authenticated-user"];
readonly options?: never;
@@ -14331,8 +15128,6 @@ export type paths = {
* List app installations accessible to the user access token
* @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
*
- * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint.
- *
* The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
*
* You can find the permissions for the installation under the `permissions` key.
@@ -14359,8 +15154,6 @@ export type paths = {
*
* The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
*
- * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint.
- *
* The access the user has to each repository is included in the hash under the `permissions` key.
*/
readonly get: operations["apps/list-installation-repos-for-authenticated-user"];
@@ -14383,16 +15176,12 @@ export type paths = {
/**
* Add a repository to an app installation
* @description Add a single repository to an installation. The authenticated user must have admin access to the repository.
- *
- * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.
*/
readonly put: operations["apps/add-repo-to-installation-for-authenticated-user"];
readonly post?: never;
/**
* Remove a repository from an app installation
* @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.
- *
- * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.
*/
readonly delete: operations["apps/remove-repo-from-installation-for-authenticated-user"];
readonly options?: never;
@@ -14443,6 +15232,13 @@ export type paths = {
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/list-for-authenticated-user"];
readonly put?: never;
@@ -14462,13 +15258,17 @@ export type paths = {
};
/**
* List public SSH keys for the authenticated user
- * @description Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Lists the public SSH keys for the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
*/
readonly get: operations["users/list-public-ssh-keys-for-authenticated-user"];
readonly put?: never;
/**
* Create a public SSH key for the authenticated user
- * @description Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Adds a public SSH key to the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
*/
readonly post: operations["users/create-public-ssh-key-for-authenticated-user"];
readonly delete?: never;
@@ -14486,14 +15286,18 @@ export type paths = {
};
/**
* Get a public SSH key for the authenticated user
- * @description View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description View extended details for a single public SSH key.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
*/
readonly get: operations["users/get-public-ssh-key-for-authenticated-user"];
readonly put?: never;
readonly post?: never;
/**
* Delete a public SSH key for the authenticated user
- * @description Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Removes a public SSH key from the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.
*/
readonly delete: operations["users/delete-public-ssh-key-for-authenticated-user"];
readonly options?: never;
@@ -14510,7 +15314,7 @@ export type paths = {
};
/**
* List subscriptions for the authenticated user
- * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps).
+ * @description Lists the active subscriptions for the authenticated user.
*/
readonly get: operations["apps/list-subscriptions-for-authenticated-user"];
readonly put?: never;
@@ -14530,7 +15334,7 @@ export type paths = {
};
/**
* List subscriptions for the authenticated user (stubbed)
- * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps).
+ * @description Lists the active subscriptions for the authenticated user.
*/
readonly get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"];
readonly put?: never;
@@ -14731,9 +15535,7 @@ export type paths = {
* List organizations for the authenticated user
* @description List organizations for the authenticated user.
*
- * **OAuth scope requirements**
- *
- * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.
+ * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.
*/
readonly get: operations["orgs/list-for-authenticated-user"];
readonly put?: never;
@@ -14755,7 +15557,7 @@ export type paths = {
* List packages for the authenticated user's namespace
* @description Lists packages owned by the authenticated user within the user's namespace.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/list-packages-for-authenticated-user"];
readonly put?: never;
@@ -14777,7 +15579,7 @@ export type paths = {
* Get a package for the authenticated user
* @description Gets a specific package for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-package-for-authenticated-user"];
readonly put?: never;
@@ -14786,8 +15588,7 @@ export type paths = {
* Delete a package for the authenticated user
* @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes.
- * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly delete: operations["packages/delete-package-for-authenticated-user"];
readonly options?: never;
@@ -14812,7 +15613,7 @@ export type paths = {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly post: operations["packages/restore-package-for-authenticated-user"];
readonly delete?: never;
@@ -14832,7 +15633,7 @@ export type paths = {
* List package versions for a package owned by the authenticated user
* @description Lists package versions for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"];
readonly put?: never;
@@ -14854,7 +15655,7 @@ export type paths = {
* Get a package version for the authenticated user
* @description Gets a specific package version for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-package-version-for-authenticated-user"];
readonly put?: never;
@@ -14863,8 +15664,9 @@ export type paths = {
* Delete a package version for the authenticated user
* @description Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes.
- * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * The authenticated user must have admin permissions in the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly delete: operations["packages/delete-package-version-for-authenticated-user"];
readonly options?: never;
@@ -14889,7 +15691,7 @@ export type paths = {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly post: operations["packages/restore-package-version-for-authenticated-user"];
readonly delete?: never;
@@ -14927,7 +15729,11 @@ export type paths = {
};
/**
* List public email addresses for the authenticated user
- * @description Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.
+ * @description Lists your publicly visible email address, which you can set with the
+ * [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)
+ * endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
*/
readonly get: operations["users/list-public-emails-for-authenticated-user"];
readonly put?: never;
@@ -14957,12 +15763,7 @@ export type paths = {
* Create a repository for the authenticated user
* @description Creates a new repository for the authenticated user.
*
- * **OAuth scope requirements**
- *
- * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
- *
- * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- * * `repo` scope to create a private repository.
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
*/
readonly post: operations["repos/create-for-authenticated-user"];
readonly delete?: never;
@@ -15024,12 +15825,16 @@ export type paths = {
readonly put?: never;
/**
* Add social accounts for the authenticated user
- * @description Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope.
+ * @description Add one or more social accounts to the authenticated user's profile.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly post: operations["users/add-social-account-for-authenticated-user"];
/**
* Delete social accounts for the authenticated user
- * @description Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope.
+ * @description Deletes one or more social accounts from the authenticated user's profile.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly delete: operations["users/delete-social-account-for-authenticated-user"];
readonly options?: never;
@@ -15046,13 +15851,17 @@ export type paths = {
};
/**
* List SSH signing keys for the authenticated user
- * @description Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)."
+ * @description Lists the SSH signing keys for the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
*/
readonly get: operations["users/list-ssh-signing-keys-for-authenticated-user"];
readonly put?: never;
/**
* Create a SSH signing key for the authenticated user
- * @description Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)."
+ * @description Creates an SSH signing key for the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.
*/
readonly post: operations["users/create-ssh-signing-key-for-authenticated-user"];
readonly delete?: never;
@@ -15070,14 +15879,18 @@ export type paths = {
};
/**
* Get an SSH signing key for the authenticated user
- * @description Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)."
+ * @description Gets extended details for an SSH signing key.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
*/
readonly get: operations["users/get-ssh-signing-key-for-authenticated-user"];
readonly put?: never;
readonly post?: never;
/**
* Delete an SSH signing key for the authenticated user
- * @description Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)."
+ * @description Deletes an SSH signing key from the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.
*/
readonly delete: operations["users/delete-ssh-signing-key-for-authenticated-user"];
readonly options?: never;
@@ -15096,7 +15909,9 @@ export type paths = {
* List repositories starred by the authenticated user
* @description Lists repositories the authenticated user has starred.
*
- * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
*/
readonly get: operations["activity/list-repos-starred-by-authenticated-user"];
readonly put?: never;
@@ -15121,7 +15936,7 @@ export type paths = {
readonly get: operations["activity/check-repo-is-starred-by-authenticated-user"];
/**
* Star a repository for the authenticated user
- * @description Note that 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)."
+ * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
readonly put: operations["activity/star-repo-for-authenticated-user"];
readonly post?: never;
@@ -15164,7 +15979,12 @@ export type paths = {
};
/**
* List teams for the authenticated user
- * @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token.
+ * @description List all of the teams across all of the organizations to which the authenticated
+ * user belongs.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.
+ *
+ * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.
*/
readonly get: operations["teams/list-for-authenticated-user"];
readonly put?: never;
@@ -15208,9 +16028,7 @@ export type paths = {
* Get a user
* @description Provides publicly available information about someone with a GitHub account.
*
- * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below"
- *
- * 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 `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/guides/getting-started-with-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/users/emails)".
*/
@@ -15233,7 +16051,8 @@ export type paths = {
/**
* Get list of conflicting packages during Docker migration for user
* @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
*/
readonly get: operations["packages/list-docker-migration-conflicting-packages-for-user"];
readonly put?: never;
@@ -15407,14 +16226,11 @@ export type paths = {
};
/**
* Get contextual information for a user
- * @description Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
+ * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
*
- * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:
+ * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).
*
- * ```shell
- * curl -u username:token
- * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
- * ```
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["users/get-context-for-user"];
readonly put?: never;
@@ -15500,7 +16316,7 @@ export type paths = {
* List packages for a user
* @description Lists all packages in a user's namespace for which the requesting user has access.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/list-packages-for-user"];
readonly put?: never;
@@ -15522,7 +16338,7 @@ export type paths = {
* Get a package for a user
* @description Gets a specific package metadata for a public package owned by a user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-package-for-user"];
readonly put?: never;
@@ -15531,9 +16347,9 @@ export type paths = {
* Delete a package for a user
* @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly delete: operations["packages/delete-package-for-user"];
readonly options?: never;
@@ -15558,9 +16374,9 @@ export type paths = {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly post: operations["packages/restore-package-for-user"];
readonly delete?: never;
@@ -15580,7 +16396,7 @@ export type paths = {
* List package versions for a package owned by a user
* @description Lists package versions for a public package owned by a specified user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-all-package-versions-for-package-owned-by-user"];
readonly put?: never;
@@ -15602,7 +16418,7 @@ export type paths = {
* Get a package version for a user
* @description Gets a specific package version for a public package owned by a specified user.
*
- * At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-package-version-for-user"];
readonly put?: never;
@@ -15611,9 +16427,9 @@ export type paths = {
* Delete package version for a user
* @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly delete: operations["packages/delete-package-version-for-user"];
readonly options?: never;
@@ -15638,9 +16454,9 @@ export type paths = {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly post: operations["packages/restore-package-version-for-user"];
readonly delete?: never;
@@ -15678,7 +16494,7 @@ export type paths = {
};
/**
* List events received by the authenticated user
- * @description These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.
+ * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.
*/
readonly get: operations["activity/list-received-events-for-user"];
readonly put?: never;
@@ -15715,7 +16531,7 @@ export type paths = {
};
/**
* List repositories for a user
- * @description Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.
+ * @description Lists public repositories for the specified user.
*/
readonly get: operations["repos/list-for-user"];
readonly put?: never;
@@ -15739,7 +16555,7 @@ export type paths = {
*
* Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * Access tokens must have the `user` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly get: operations["billing/get-github-actions-billing-user"];
readonly put?: never;
@@ -15763,7 +16579,7 @@ export type paths = {
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `user` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly get: operations["billing/get-github-packages-billing-user"];
readonly put?: never;
@@ -15787,7 +16603,7 @@ export type paths = {
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `user` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly get: operations["billing/get-shared-storage-billing-user"];
readonly put?: never;
@@ -15849,7 +16665,9 @@ export type paths = {
* List repositories starred by a user
* @description Lists repositories a user has starred.
*
- * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
*/
readonly get: operations["activity/list-repos-starred-by-user"];
readonly put?: never;
@@ -15949,8 +16767,11 @@ export type components = {
readonly following_url: string;
/** Format: uri-template */
readonly gists_url: string;
- /** Format: uri-template */
- readonly hub_url: string;
+ /**
+ * Format: uri-template
+ * @deprecated
+ */
+ readonly hub_url?: string;
/** Format: uri-template */
readonly issue_search_url: string;
/** Format: uri-template */
@@ -15997,210 +16818,212 @@ export type components = {
* @enum {string}
*/
readonly "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift";
- /**
- * Simple User
- * @description A GitHub user.
- */
- readonly "simple-user": {
- readonly name?: string | null;
- readonly email?: string | null;
- /** @example octocat */
- readonly login: string;
- /** @example 1 */
- readonly id: number;
- /** @example MDQ6VXNlcjE= */
- readonly node_id: string;
- /**
- * Format: uri
- * @example https://github.com/images/error/octocat_happy.gif
- */
- readonly avatar_url: string;
- /** @example 41d064eb2195891e12d0413f63227ea7 */
- readonly gravatar_id: string | null;
- /**
- * Format: uri
- * @example https://api.github.com/users/octocat
- */
- readonly url: string;
- /**
- * Format: uri
- * @example https://github.com/octocat
- */
- readonly html_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/users/octocat/followers
- */
- readonly followers_url: string;
- /** @example https://api.github.com/users/octocat/following{/other_user} */
- readonly following_url: string;
- /** @example https://api.github.com/users/octocat/gists{/gist_id} */
- readonly gists_url: string;
- /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */
- readonly starred_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/users/octocat/subscriptions
- */
- readonly subscriptions_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/users/octocat/orgs
- */
- readonly organizations_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/users/octocat/repos
- */
- readonly repos_url: string;
- /** @example https://api.github.com/users/octocat/events{/privacy} */
- readonly events_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/users/octocat/received_events
- */
- readonly received_events_url: string;
- /** @example User */
- readonly type: string;
- readonly site_admin: boolean;
- /** @example "2020-07-09T00:17:55Z" */
- readonly starred_at?: string;
- };
- /**
- * @description The type of credit the user is receiving.
- * @enum {string}
- */
- readonly "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other";
- /** @description A GitHub Security Advisory. */
- readonly "global-advisory": {
- /** @description The GitHub Security Advisory ID. */
- readonly ghsa_id: string;
- /** @description The Common Vulnerabilities and Exposures (CVE) ID. */
- readonly cve_id: string | null;
- /** @description The API URL for the advisory. */
- readonly url: string;
- /**
- * Format: uri
- * @description The URL for the advisory.
- */
- readonly html_url: string;
- /**
- * Format: uri
- * @description The API URL for the repository advisory.
- */
- readonly repository_advisory_url: string | null;
- /** @description A short summary of the advisory. */
- readonly summary: string;
- /** @description A detailed description of what the advisory entails. */
- readonly description: string | null;
- /**
- * @description The type of advisory.
- * @enum {string}
- */
- readonly type: "reviewed" | "unreviewed" | "malware";
- /**
- * @description The severity of the advisory.
- * @enum {string}
- */
- readonly severity: "critical" | "high" | "medium" | "low" | "unknown";
- /**
- * Format: uri
- * @description The URL of the advisory's source code.
- */
- readonly source_code_location: string | null;
- readonly identifiers: {
- /**
- * @description The type of identifier.
- * @enum {string}
- */
- readonly type: "CVE" | "GHSA";
- /** @description The identifier value. */
- readonly value: string;
- }[] | null;
- readonly references: string[] | null;
- /**
- * Format: date-time
- * @description The date and time of when the advisory was published, in ISO 8601 format.
- */
- readonly published_at: string;
- /**
- * Format: date-time
- * @description The date and time of when the advisory was last updated, in ISO 8601 format.
- */
- readonly updated_at: string;
- /**
- * Format: date-time
- * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.
- */
- readonly github_reviewed_at: string | null;
- /**
- * Format: date-time
- * @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 nvd_published_at: string | null;
- /**
- * Format: date-time
- * @description The date and time of when the advisory was withdrawn, in ISO 8601 format.
- */
- readonly withdrawn_at: string | null;
- /** @description The products and respective version ranges affected by the advisory. */
- readonly vulnerabilities: {
- /** @description The name of the package affected by the vulnerability. */
- readonly package: {
- readonly ecosystem: components["schemas"]["security-advisory-ecosystems"];
- /** @description The unique package name within its ecosystem. */
- readonly name: string | null;
- } | null;
- /** @description The range of the package versions affected by the vulnerability. */
- readonly vulnerable_version_range: string | null;
- /** @description The package version that resolve the vulnerability. */
- readonly first_patched_version: string | null;
- /** @description The functions in the package that are affected by the vulnerability. */
- readonly vulnerable_functions: string[] | null;
- }[] | null;
- readonly cvss: {
- /** @description The CVSS vector. */
- readonly vector_string: string | null;
- /** @description The CVSS score. */
- readonly score: number | null;
+ /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */
+ readonly vulnerability: {
+ /** @description The name of the package affected by the vulnerability. */
+ readonly package: {
+ readonly ecosystem: components["schemas"]["security-advisory-ecosystems"];
+ /** @description The unique package name within its ecosystem. */
+ readonly name: string | null;
} | null;
- readonly cwes: {
- /** @description The Common Weakness Enumeration (CWE) identifier. */
- readonly cwe_id: string;
- /** @description The name of the CWE. */
- readonly name: string;
- }[] | null;
- /** @description The users who contributed to the advisory. */
- readonly credits: {
- readonly user: components["schemas"]["simple-user"];
- readonly type: components["schemas"]["security-advisory-credit-types"];
- }[] | null;
- };
- /**
- * Basic Error
- * @description Basic Error
- */
- readonly "basic-error": {
- readonly message?: string;
- readonly documentation_url?: string;
- readonly url?: string;
- readonly status?: string;
- };
- /**
- * Validation Error Simple
- * @description Validation Error Simple
- */
- readonly "validation-error-simple": {
- readonly message: string;
- readonly documentation_url: string;
- readonly errors?: string[];
+ /** @description The range of the package versions affected by the vulnerability. */
+ readonly vulnerable_version_range: string | null;
+ /** @description The package version that resolves the vulnerability. */
+ readonly first_patched_version: string | null;
+ /** @description The functions in the package that are affected by the vulnerability. */
+ readonly vulnerable_functions: string[] | null;
};
/**
* Simple User
* @description A GitHub user.
*/
- readonly "nullable-simple-user": {
+ readonly "simple-user": {
+ readonly name?: string | null;
+ readonly email?: string | null;
+ /** @example octocat */
+ readonly login: string;
+ /** @example 1 */
+ readonly id: number;
+ /** @example MDQ6VXNlcjE= */
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @example https://github.com/images/error/octocat_happy.gif
+ */
+ readonly avatar_url: string;
+ /** @example 41d064eb2195891e12d0413f63227ea7 */
+ readonly gravatar_id: string | null;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat
+ */
+ readonly url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat
+ */
+ readonly html_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/followers
+ */
+ readonly followers_url: string;
+ /** @example https://api.github.com/users/octocat/following{/other_user} */
+ readonly following_url: string;
+ /** @example https://api.github.com/users/octocat/gists{/gist_id} */
+ readonly gists_url: string;
+ /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */
+ readonly starred_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/subscriptions
+ */
+ readonly subscriptions_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/orgs
+ */
+ readonly organizations_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/repos
+ */
+ readonly repos_url: string;
+ /** @example https://api.github.com/users/octocat/events{/privacy} */
+ readonly events_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/received_events
+ */
+ readonly received_events_url: string;
+ /** @example User */
+ readonly type: string;
+ readonly site_admin: boolean;
+ /** @example "2020-07-09T00:17:55Z" */
+ readonly starred_at?: string;
+ };
+ /**
+ * @description The type of credit the user is receiving.
+ * @enum {string}
+ */
+ readonly "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other";
+ /** @description A GitHub Security Advisory. */
+ readonly "global-advisory": {
+ /** @description The GitHub Security Advisory ID. */
+ readonly ghsa_id: string;
+ /** @description The Common Vulnerabilities and Exposures (CVE) ID. */
+ readonly cve_id: string | null;
+ /** @description The API URL for the advisory. */
+ readonly url: string;
+ /**
+ * Format: uri
+ * @description The URL for the advisory.
+ */
+ readonly html_url: string;
+ /**
+ * Format: uri
+ * @description The API URL for the repository advisory.
+ */
+ readonly repository_advisory_url: string | null;
+ /** @description A short summary of the advisory. */
+ readonly summary: string;
+ /** @description A detailed description of what the advisory entails. */
+ readonly description: string | null;
+ /**
+ * @description The type of advisory.
+ * @enum {string}
+ */
+ readonly type: "reviewed" | "unreviewed" | "malware";
+ /**
+ * @description The severity of the advisory.
+ * @enum {string}
+ */
+ readonly severity: "critical" | "high" | "medium" | "low" | "unknown";
+ /**
+ * Format: uri
+ * @description The URL of the advisory's source code.
+ */
+ readonly source_code_location: string | null;
+ readonly identifiers: {
+ /**
+ * @description The type of identifier.
+ * @enum {string}
+ */
+ readonly type: "CVE" | "GHSA";
+ /** @description The identifier value. */
+ readonly value: string;
+ }[] | null;
+ readonly references: string[] | null;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was published, in ISO 8601 format.
+ */
+ readonly published_at: string;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was last updated, in ISO 8601 format.
+ */
+ readonly updated_at: string;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.
+ */
+ readonly github_reviewed_at: string | null;
+ /**
+ * Format: date-time
+ * @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 nvd_published_at: string | null;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was withdrawn, in ISO 8601 format.
+ */
+ readonly withdrawn_at: string | null;
+ /** @description The products and respective version ranges affected by the advisory. */
+ readonly vulnerabilities: components["schemas"]["vulnerability"][] | null;
+ readonly cvss: {
+ /** @description The CVSS vector. */
+ readonly vector_string: string | null;
+ /** @description The CVSS score. */
+ readonly score: number | null;
+ } | null;
+ readonly cwes: {
+ /** @description The Common Weakness Enumeration (CWE) identifier. */
+ readonly cwe_id: string;
+ /** @description The name of the CWE. */
+ readonly name: string;
+ }[] | null;
+ /** @description The users who contributed to the advisory. */
+ readonly credits: {
+ readonly user: components["schemas"]["simple-user"];
+ readonly type: components["schemas"]["security-advisory-credit-types"];
+ }[] | null;
+ };
+ /**
+ * Basic Error
+ * @description Basic Error
+ */
+ readonly "basic-error": {
+ readonly message?: string;
+ readonly documentation_url?: string;
+ readonly url?: string;
+ readonly status?: string;
+ };
+ /**
+ * Validation Error Simple
+ * @description Validation Error Simple
+ */
+ readonly "validation-error-simple": {
+ readonly message: string;
+ readonly documentation_url: string;
+ readonly errors?: string[];
+ };
+ /**
+ * Simple User
+ * @description A GitHub user.
+ */
+ readonly "nullable-simple-user": {
readonly name?: string | null;
readonly email?: string | null;
/** @example octocat */
@@ -16346,7 +17169,7 @@ export type components = {
readonly webhook_secret?: string | null;
/** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */
readonly pem?: string;
- };
+ } | null;
/**
* Format: uri
* @description The URL to which the payloads will be delivered.
@@ -16642,11 +17465,21 @@ export type components = {
* @enum {string}
*/
readonly checks?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to create, edit, delete, and list Codespaces.
+ * @enum {string}
+ */
+ readonly codespaces?: "read" | "write";
/**
* @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
* @enum {string}
*/
readonly contents?: "read" | "write";
+ /**
+ * @description The leve of permission to grant the access token to manage Dependabot secrets.
+ * @enum {string}
+ */
+ readonly dependabot_secrets?: "read" | "write";
/**
* @description The level of permission to grant the access token for deployments and deployment statuses.
* @enum {string}
@@ -16682,6 +17515,11 @@ export type components = {
* @enum {string}
*/
readonly pull_requests?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.
+ * @enum {string}
+ */
+ readonly repository_custom_properties?: "read" | "write";
/**
* @description The level of permission to grant the access token to manage the post-receive hooks for a repository.
* @enum {string}
@@ -16738,20 +17576,35 @@ export type components = {
*/
readonly organization_administration?: "read" | "write";
/**
- * @description The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.
+ * @description The level of permission to grant the access token for custom repository roles management.
* @enum {string}
*/
readonly organization_custom_roles?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for custom organization roles management.
+ * @enum {string}
+ */
+ readonly organization_custom_org_roles?: "read" | "write";
/**
* @description The level of permission to grant the access token for custom property management.
* @enum {string}
*/
readonly organization_custom_properties?: "read" | "write" | "admin";
+ /**
+ * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change.
+ * @enum {string}
+ */
+ readonly organization_copilot_seat_management?: "write";
/**
* @description The level of permission to grant the access token to view and manage announcement banners for an organization.
* @enum {string}
*/
readonly organization_announcement_banners?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view events triggered by an activity in an organization.
+ * @enum {string}
+ */
+ readonly organization_events?: "read";
/**
* @description The level of permission to grant the access token to manage the post-receive hooks for an organization.
* @enum {string}
@@ -16802,6 +17655,41 @@ export type components = {
* @enum {string}
*/
readonly team_discussions?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage the email addresses belonging to a user.
+ * @enum {string}
+ */
+ readonly email_addresses?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage the followers belonging to a user.
+ * @enum {string}
+ */
+ readonly followers?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage git SSH keys.
+ * @enum {string}
+ */
+ readonly git_ssh_keys?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view and manage GPG keys belonging to a user.
+ * @enum {string}
+ */
+ readonly gpg_keys?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view and manage interaction limits on a repository.
+ * @enum {string}
+ */
+ readonly interaction_limits?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage the profile settings belonging to a user.
+ * @enum {string}
+ */
+ readonly profile?: "write";
+ /**
+ * @description The level of permission to grant the access token to list and manage repositories a user is starring.
+ * @enum {string}
+ */
+ readonly starring?: "read" | "write";
};
/**
* Installation
@@ -16904,7 +17792,6 @@ export type components = {
/** @example octocat/Hello-World */
readonly full_name: string;
readonly license: components["schemas"]["nullable-license-simple"];
- readonly organization?: components["schemas"]["nullable-simple-user"];
readonly forks: number;
readonly permissions?: {
readonly admin: boolean;
@@ -17072,7 +17959,7 @@ export type components = {
/** @example 80 */
readonly watchers_count: number;
/**
- * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
* @example 108
*/
readonly size: number;
@@ -17155,150 +18042,6 @@ export type components = {
* @example true
*/
readonly allow_rebase_merge: boolean;
- readonly template_repository?: {
- readonly id?: number;
- readonly node_id?: string;
- readonly name?: string;
- readonly full_name?: string;
- readonly owner?: {
- readonly login?: string;
- readonly id?: number;
- readonly node_id?: string;
- readonly avatar_url?: string;
- readonly gravatar_id?: string;
- readonly url?: string;
- readonly html_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly organizations_url?: string;
- readonly repos_url?: string;
- readonly events_url?: string;
- readonly received_events_url?: string;
- readonly type?: string;
- readonly site_admin?: boolean;
- };
- readonly private?: boolean;
- readonly html_url?: string;
- readonly description?: string;
- readonly fork?: boolean;
- readonly url?: string;
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly forks_url?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly git_url?: string;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly notifications_url?: string;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly ssh_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly clone_url?: string;
- readonly mirror_url?: string;
- readonly hooks_url?: string;
- readonly svn_url?: string;
- readonly homepage?: string;
- readonly language?: string;
- readonly forks_count?: number;
- readonly stargazers_count?: number;
- readonly watchers_count?: number;
- readonly size?: number;
- readonly default_branch?: string;
- readonly open_issues_count?: number;
- readonly is_template?: boolean;
- readonly topics?: string[];
- readonly has_issues?: boolean;
- readonly has_projects?: boolean;
- readonly has_wiki?: boolean;
- readonly has_pages?: boolean;
- readonly has_downloads?: boolean;
- readonly archived?: boolean;
- readonly disabled?: boolean;
- readonly visibility?: string;
- readonly pushed_at?: string;
- readonly created_at?: string;
- readonly updated_at?: string;
- readonly permissions?: {
- readonly admin?: boolean;
- readonly maintain?: boolean;
- readonly push?: boolean;
- readonly triage?: boolean;
- readonly pull?: boolean;
- };
- readonly allow_rebase_merge?: boolean;
- readonly temp_clone_token?: string;
- readonly allow_squash_merge?: boolean;
- readonly allow_auto_merge?: boolean;
- readonly delete_branch_on_merge?: boolean;
- readonly allow_update_branch?: boolean;
- readonly use_squash_pr_title_as_default?: boolean;
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- readonly allow_merge_commit?: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
- } | null;
readonly temp_clone_token?: string;
/**
* @description Whether to allow squash merges for pull requests.
@@ -17377,8 +18120,6 @@ export type components = {
* @default false
*/
readonly web_commit_signoff_required: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
readonly open_issues: number;
readonly watchers: number;
readonly master_branch?: string;
@@ -17907,6 +18648,51 @@ export type components = {
/** Format: uri */
readonly html_url: string | null;
};
+ /**
+ * Copilot Usage Metrics
+ * @description Summary of Copilot usage.
+ */
+ readonly "copilot-usage-metrics": {
+ /**
+ * Format: date
+ * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format.
+ */
+ readonly day: string;
+ /** @description The total number of Copilot code completion suggestions shown to users. */
+ readonly total_suggestions_count?: number;
+ /** @description The total number of Copilot code completion suggestions accepted by users. */
+ readonly total_acceptances_count?: number;
+ /** @description The total number of lines of code completions suggested by Copilot. */
+ readonly total_lines_suggested?: number;
+ /** @description The total number of lines of code completions accepted by users. */
+ readonly total_lines_accepted?: number;
+ /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */
+ readonly total_active_users?: number;
+ /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */
+ readonly total_chat_acceptances?: number;
+ /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */
+ readonly total_chat_turns?: number;
+ /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */
+ readonly total_active_chat_users?: number;
+ /** @description Breakdown of Copilot code completions usage by language and editor */
+ readonly breakdown: {
+ /** @description The language in which Copilot suggestions were shown to users in the specified editor. */
+ readonly language?: string;
+ /** @description The editor in which Copilot suggestions were shown to users for the specified language. */
+ readonly editor?: string;
+ /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */
+ readonly suggestions_count?: number;
+ /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */
+ readonly acceptances_count?: number;
+ /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */
+ readonly lines_suggested?: number;
+ /** @description The number of lines of code accepted by users in the editor specified during the day specified. */
+ readonly lines_accepted?: number;
+ /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */
+ readonly active_users?: number;
+ readonly [key: string]: unknown;
+ }[] | null;
+ };
/** @description The security alert number. */
readonly "alert-number": number;
/** @description Details for the vulnerable package. */
@@ -19314,6 +20100,7 @@ export type components = {
readonly codespaces?: string[];
readonly copilot?: string[];
readonly packages?: string[];
+ readonly actions?: string[];
};
};
readonly "security-and-analysis": {
@@ -19487,7 +20274,7 @@ export type components = {
readonly forks_count?: number;
readonly stargazers_count?: number;
readonly watchers_count?: number;
- /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */
+ /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */
readonly size?: number;
readonly default_branch?: string;
readonly open_issues_count?: number;
@@ -20122,11 +20909,13 @@ export type components = {
readonly "code-scanning-alert-dismissed-reason": null | "false positive" | "won't fix" | "used in tests";
/** @description The dismissal comment associated with the dismissal of the alert. */
readonly "code-scanning-alert-dismissed-comment": string | null;
- readonly "code-scanning-alert-rule": {
+ readonly "code-scanning-alert-rule-summary": {
/** @description A unique identifier for the rule used to detect the alert. */
readonly id?: string | null;
/** @description The name of the rule used to detect the alert. */
readonly name?: string;
+ /** @description A set of tags applicable for the rule. */
+ readonly tags?: string[] | null;
/**
* @description The severity of the alert.
* @enum {string|null}
@@ -20139,14 +20928,6 @@ export type components = {
readonly security_severity_level?: "low" | "medium" | "high" | "critical";
/** @description A short description of the rule used to detect the alert. */
readonly description?: string;
- /** @description description of the rule used to detect the alert. */
- readonly full_description?: string;
- /** @description A set of tags applicable for the rule. */
- readonly tags?: string[] | null;
- /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */
- readonly help?: string | null;
- /** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
};
/** @description The version of the tool used to generate the code scanning analysis. */
readonly "code-scanning-analysis-tool-version": string | null;
@@ -20206,7 +20987,7 @@ export type components = {
readonly dismissed_at: components["schemas"]["alert-dismissed-at"];
readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"];
readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
- readonly rule: components["schemas"]["code-scanning-alert-rule"];
+ readonly rule: components["schemas"]["code-scanning-alert-rule-summary"];
readonly tool: components["schemas"]["code-scanning-analysis-tool"];
readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
readonly repository: components["schemas"]["simple-repository"];
@@ -20496,7 +21277,17 @@ export type components = {
* @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.
* @enum {string}
*/
- readonly copilot_chat?: "enabled" | "disabled" | "unconfigured";
+ readonly ide_chat?: "enabled" | "disabled" | "unconfigured";
+ /**
+ * @description The organization policy for allowing or disallowing organization members to use Copilot features within github.com.
+ * @enum {string}
+ */
+ readonly platform_chat?: "enabled" | "disabled" | "unconfigured";
+ /**
+ * @description The organization policy for allowing or disallowing organization members to use Copilot within their CLI.
+ * @enum {string}
+ */
+ readonly cli?: "enabled" | "disabled" | "unconfigured";
/**
* @description The mode of assigning new seats.
* @enum {string}
@@ -20902,7 +21693,7 @@ export type components = {
readonly forks_count?: number;
readonly stargazers_count?: number;
readonly watchers_count?: number;
- /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */
+ /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */
readonly size?: number;
readonly default_branch?: string;
readonly open_issues_count?: number;
@@ -21433,11 +22224,18 @@ export type components = {
/** @description Whether the property is required. */
readonly required?: boolean;
/** @description Default value of the property */
- readonly default_value?: string | null;
+ readonly default_value?: (string | string[]) | null;
/** @description Short description of the property */
readonly description?: string | null;
- /** @description Ordered list of allowed values of the property */
+ /** @description An ordered list of the allowed values of the property.
+ * The property can have up to 200 allowed values. */
readonly allowed_values?: string[] | null;
+ /**
+ * @description Who can edit the values of the property
+ * @example org_actors
+ * @enum {string|null}
+ */
+ readonly values_editable_by?: "org_actors" | "org_and_repo_actors";
};
/**
* Custom Property Value
@@ -21447,7 +22245,7 @@ export type components = {
/** @description The name of the property */
readonly property_name: string;
/** @description The value assigned to the property */
- readonly value: string | null;
+ readonly value: (string | string[]) | null;
};
/**
* Organization Repository Custom Property Values
@@ -21464,1150 +22262,395 @@ export type components = {
readonly properties: components["schemas"]["custom-property-value"][];
};
/**
- * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).
- * @enum {string}
- */
- readonly "repository-rule-enforcement": "disabled" | "active" | "evaluate";
- /**
- * Repository Ruleset Bypass Actor
- * @description An actor that can bypass rules in a ruleset
+ * Repository
+ * @description A repository on GitHub.
*/
- readonly "repository-ruleset-bypass-actor": {
- /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */
- readonly actor_id: number;
+ readonly "nullable-repository": {
/**
- * @description The type of actor that can bypass a ruleset
- * @enum {string}
+ * @description Unique identifier of the repository
+ * @example 42
*/
- readonly actor_type: "RepositoryRole" | "Team" | "Integration" | "OrganizationAdmin";
+ readonly id: number;
+ /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ readonly node_id: string;
/**
- * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests.
- * @enum {string}
+ * @description The name of the repository.
+ * @example Team Environment
*/
- readonly bypass_mode: "always" | "pull_request";
- };
- /**
- * Repository ruleset conditions for ref names
- * @description Parameters for a repository ruleset ref name condition
- */
- readonly "repository-ruleset-conditions": {
- readonly ref_name?: {
- /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */
- readonly include?: string[];
- /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */
- readonly exclude?: string[];
- };
- };
- /**
- * Repository ruleset conditions for repository names
- * @description Parameters for a repository name condition
- */
- readonly "repository-ruleset-conditions-repository-name-target": {
- readonly repository_name: {
- /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */
- readonly include?: string[];
- /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */
- readonly exclude?: string[];
- /** @description Whether renaming of target repositories is prevented. */
- readonly protected?: boolean;
- };
- };
- /**
- * Repository ruleset conditions for repository IDs
- * @description Parameters for a repository ID condition
- */
- readonly "repository-ruleset-conditions-repository-id-target": {
- readonly repository_id: {
- /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */
- readonly repository_ids?: number[];
- };
- };
- /**
- * Organization ruleset conditions
- * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.
- *
- */
- readonly "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]);
- /**
- * creation
- * @description Only allow users with bypass permission to create matching refs.
- */
- readonly "repository-rule-creation": {
- /** @enum {string} */
- readonly type: "creation";
- };
- /**
- * update
- * @description Only allow users with bypass permission to update matching refs.
- */
- readonly "repository-rule-update": {
- /** @enum {string} */
- readonly type: "update";
- readonly parameters?: {
- /** @description Branch can pull changes from its upstream repository */
- readonly update_allows_fetch_and_merge: boolean;
- };
- };
- /**
- * deletion
- * @description Only allow users with bypass permissions to delete matching refs.
- */
- readonly "repository-rule-deletion": {
- /** @enum {string} */
- readonly type: "deletion";
- };
- /**
- * required_linear_history
- * @description Prevent merge commits from being pushed to matching refs.
- */
- readonly "repository-rule-required-linear-history": {
- /** @enum {string} */
- readonly type: "required_linear_history";
- };
- /**
- * required_deployments
- * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
- */
- readonly "repository-rule-required-deployments": {
- /** @enum {string} */
- readonly type: "required_deployments";
- readonly parameters?: {
- /** @description The environments that must be successfully deployed to before branches can be merged. */
- readonly required_deployment_environments: string[];
- };
- };
- /**
- * required_signatures
- * @description Commits pushed to matching refs must have verified signatures.
- */
- readonly "repository-rule-required-signatures": {
- /** @enum {string} */
- readonly type: "required_signatures";
- };
- /**
- * pull_request
- * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
- */
- readonly "repository-rule-pull-request": {
- /** @enum {string} */
- readonly type: "pull_request";
- readonly parameters?: {
- /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */
- readonly dismiss_stale_reviews_on_push: boolean;
- /** @description Require an approving review in pull requests that modify files that have a designated code owner. */
- readonly require_code_owner_review: boolean;
- /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */
- readonly require_last_push_approval: boolean;
- /** @description The number of approving reviews that are required before a pull request can be merged. */
- readonly required_approving_review_count: number;
- /** @description All conversations on code must be resolved before a pull request can be merged. */
- readonly required_review_thread_resolution: boolean;
- };
- };
- /**
- * StatusCheckConfiguration
- * @description Required status check
- */
- readonly "repository-rule-params-status-check-configuration": {
- /** @description The status check context name that must be present on the commit. */
- readonly context: string;
- /** @description The optional integration ID that this status check must originate from. */
- readonly integration_id?: number;
- };
- /**
- * required_status_checks
- * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
- */
- readonly "repository-rule-required-status-checks": {
- /** @enum {string} */
- readonly type: "required_status_checks";
- readonly parameters?: {
- /** @description Status checks that are required. */
- readonly required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][];
- /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */
- readonly strict_required_status_checks_policy: boolean;
- };
- };
- /**
- * non_fast_forward
- * @description Prevent users with push access from force pushing to refs.
- */
- readonly "repository-rule-non-fast-forward": {
- /** @enum {string} */
- readonly type: "non_fast_forward";
- };
- /**
- * commit_message_pattern
- * @description Parameters to be used for the commit_message_pattern rule
- */
- readonly "repository-rule-commit-message-pattern": {
- /** @enum {string} */
- readonly type: "commit_message_pattern";
- readonly parameters?: {
- /** @description How this rule will appear to users. */
- readonly name?: string;
- /** @description If true, the rule will fail if the pattern matches. */
- readonly negate?: boolean;
- /**
- * @description The operator to use for matching.
- * @enum {string}
- */
- readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
- /** @description The pattern to match with. */
- readonly pattern: string;
- };
- };
- /**
- * commit_author_email_pattern
- * @description Parameters to be used for the commit_author_email_pattern rule
- */
- readonly "repository-rule-commit-author-email-pattern": {
- /** @enum {string} */
- readonly type: "commit_author_email_pattern";
- readonly parameters?: {
- /** @description How this rule will appear to users. */
- readonly name?: string;
- /** @description If true, the rule will fail if the pattern matches. */
- readonly negate?: boolean;
- /**
- * @description The operator to use for matching.
- * @enum {string}
- */
- readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
- /** @description The pattern to match with. */
- readonly pattern: string;
- };
- };
- /**
- * committer_email_pattern
- * @description Parameters to be used for the committer_email_pattern rule
- */
- readonly "repository-rule-committer-email-pattern": {
- /** @enum {string} */
- readonly type: "committer_email_pattern";
- readonly parameters?: {
- /** @description How this rule will appear to users. */
- readonly name?: string;
- /** @description If true, the rule will fail if the pattern matches. */
- readonly negate?: boolean;
- /**
- * @description The operator to use for matching.
- * @enum {string}
- */
- readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
- /** @description The pattern to match with. */
- readonly pattern: string;
- };
- };
- /**
- * branch_name_pattern
- * @description Parameters to be used for the branch_name_pattern rule
- */
- readonly "repository-rule-branch-name-pattern": {
- /** @enum {string} */
- readonly type: "branch_name_pattern";
- readonly parameters?: {
- /** @description How this rule will appear to users. */
- readonly name?: string;
- /** @description If true, the rule will fail if the pattern matches. */
- readonly negate?: boolean;
- /**
- * @description The operator to use for matching.
- * @enum {string}
- */
- readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
- /** @description The pattern to match with. */
- readonly pattern: string;
- };
- };
- /**
- * tag_name_pattern
- * @description Parameters to be used for the tag_name_pattern rule
- */
- readonly "repository-rule-tag-name-pattern": {
- /** @enum {string} */
- readonly type: "tag_name_pattern";
- readonly parameters?: {
- /** @description How this rule will appear to users. */
- readonly name?: string;
- /** @description If true, the rule will fail if the pattern matches. */
- readonly negate?: boolean;
- /**
- * @description The operator to use for matching.
- * @enum {string}
- */
- readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
- /** @description The pattern to match with. */
- readonly pattern: string;
- };
- };
- /**
- * WorkflowFileReference
- * @description A workflow that must run for this rule to pass
- */
- readonly "repository-rule-params-workflow-file-reference": {
- /** @description The path to the workflow file */
- readonly path: string;
- /** @description The ref (branch or tag) of the workflow file to use */
- readonly ref?: string;
- /** @description The ID of the repository where the workflow is defined */
- readonly repository_id: number;
- /** @description The commit SHA of the workflow file to use */
- readonly sha?: string;
- };
- /**
- * workflows
- * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
- */
- readonly "repository-rule-workflows": {
- /** @enum {string} */
- readonly type: "workflows";
- readonly parameters?: {
- /** @description Workflows that must pass for this rule to pass. */
- readonly workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][];
- };
- };
- /**
- * Repository Rule
- * @description A repository rule.
- */
- readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-workflows"];
- /**
- * Repository ruleset
- * @description A set of rules to apply when specified conditions are met.
- */
- readonly "repository-ruleset": {
- /** @description The ID of the ruleset */
- readonly id: number;
- /** @description The name of the ruleset */
readonly name: string;
+ /** @example octocat/Hello-World */
+ readonly full_name: string;
+ readonly license: components["schemas"]["nullable-license-simple"];
+ readonly forks: number;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly pull: boolean;
+ readonly triage?: boolean;
+ readonly push: boolean;
+ readonly maintain?: boolean;
+ };
+ readonly owner: components["schemas"]["simple-user"];
/**
- * @description The target of the ruleset
- * @enum {string}
+ * @description Whether the repository is private or public.
+ * @default false
*/
- readonly target?: "branch" | "tag";
+ readonly private: boolean;
/**
- * @description The type of the source of the ruleset
- * @enum {string}
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World
*/
- readonly source_type?: "Repository" | "Organization";
- /** @description The name of the source */
- readonly source: string;
- readonly enforcement: components["schemas"]["repository-rule-enforcement"];
- /** @description The actors that can bypass the rules in this ruleset */
- readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][];
+ readonly html_url: string;
+ /** @example This your first repo! */
+ readonly description: string | null;
+ readonly fork: boolean;
/**
- * @description The bypass type of the user making the API request for this ruleset. This field is only returned when
- * querying the repository-level endpoint.
- * @enum {string}
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World
*/
- readonly current_user_can_bypass?: "always" | "pull_requests_only" | "never";
- readonly node_id?: string;
- readonly _links?: {
- readonly self?: {
- /** @description The URL of the ruleset */
- readonly href?: string;
- };
- readonly html?: {
- /** @description The html URL of the ruleset */
- readonly href?: string;
- };
- };
- readonly conditions?: components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"];
- readonly rules?: components["schemas"]["repository-rule"][];
- /** Format: date-time */
- readonly created_at?: string;
- /** Format: date-time */
- readonly updated_at?: string;
- };
- /**
- * Rule Suites
- * @description Response
- */
- readonly "rule-suites": {
- /** @description The unique identifier of the rule insight. */
- readonly id?: number;
- /** @description The number that identifies the user. */
- readonly actor_id?: number;
- /** @description The handle for the GitHub user account. */
- readonly actor_name?: string;
- /** @description The first commit sha before the push evaluation. */
- readonly before_sha?: string;
- /** @description The last commit sha in the push evaluation. */
- readonly after_sha?: string;
- /** @description The ref name that the evaluation ran on. */
- readonly ref?: string;
- /** @description The ID of the repository associated with the rule evaluation. */
- readonly repository_id?: number;
- /** @description The name of the repository without the `.git` extension. */
- readonly repository_name?: string;
+ readonly url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
+ readonly archive_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
+ readonly assignees_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
+ readonly blobs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
+ readonly branches_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
+ readonly collaborators_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
+ readonly comments_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
+ readonly commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
+ readonly compare_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
+ readonly contents_url: string;
/**
- * Format: date-time
- * @example 2011-01-26T19:06:43Z
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/contributors
*/
- readonly pushed_at?: string;
+ readonly contributors_url: string;
/**
- * @description The result of the rule evaluations for rules with the `active` enforcement status.
- * @enum {string}
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/deployments
*/
- readonly result?: "pass" | "fail" | "bypass";
+ readonly deployments_url: string;
/**
- * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`.
- * @enum {string}
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/downloads
*/
- readonly evaluation_result?: "pass" | "fail";
- }[];
- /**
- * Rule Suite
- * @description Response
- */
- readonly "rule-suite": {
- /** @description The unique identifier of the rule insight. */
- readonly id?: number;
- /** @description The number that identifies the user. */
- readonly actor_id?: number;
- /** @description The handle for the GitHub user account. */
- readonly actor_name?: string;
- /** @description The first commit sha before the push evaluation. */
- readonly before_sha?: string;
- /** @description The last commit sha in the push evaluation. */
- readonly after_sha?: string;
- /** @description The ref name that the evaluation ran on. */
- readonly ref?: string;
- /** @description The ID of the repository associated with the rule evaluation. */
- readonly repository_id?: number;
- /** @description The name of the repository without the `.git` extension. */
- readonly repository_name?: string;
+ readonly downloads_url: string;
/**
- * Format: date-time
- * @example 2011-01-26T19:06:43Z
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/events
*/
- readonly pushed_at?: string;
+ readonly events_url: string;
/**
- * @description The result of the rule evaluations for rules with the `active` enforcement status.
- * @enum {string}
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/forks
*/
- readonly result?: "pass" | "fail" | "bypass";
- /**
- * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`.
- * @enum {string}
- */
- readonly evaluation_result?: "pass" | "fail";
- /** @description Details on the evaluated rules. */
- readonly rule_evaluations?: {
- readonly rule_source?: {
- /** @description The type of rule source. */
- readonly type?: string;
- /** @description The ID of the rule source. */
- readonly id?: number | null;
- /** @description The name of the rule source. */
- readonly name?: string | null;
- };
- /**
- * @description The enforcement level of this rule source.
- * @enum {string}
- */
- readonly enforcement?: "active" | "evaluate" | "deleted ruleset";
- /**
- * @description The result of the evaluation of the individual rule.
- * @enum {string}
- */
- readonly result?: "pass" | "fail";
- /** @description The type of rule. */
- readonly rule_type?: string;
- /** @description Any associated details with the rule evaluation. */
- readonly details?: string;
- }[];
- };
- /** @description A product affected by the vulnerability detailed in a repository security advisory. */
- readonly "repository-advisory-vulnerability": {
- /** @description The name of the package affected by the vulnerability. */
- readonly package: {
- readonly ecosystem: components["schemas"]["security-advisory-ecosystems"];
- /** @description The unique package name within its ecosystem. */
- readonly name: string | null;
- } | null;
- /** @description The range of the package versions affected by the vulnerability. */
- readonly vulnerable_version_range: string | null;
- /** @description The package version(s) that resolve the vulnerability. */
- readonly patched_versions: string | null;
- /** @description The functions in the package that are affected. */
- readonly vulnerable_functions: string[] | null;
- };
- /** @description A credit given to a user for a repository security advisory. */
- readonly "repository-advisory-credit": {
- readonly user: components["schemas"]["simple-user"];
- readonly type: components["schemas"]["security-advisory-credit-types"];
- /**
- * @description The state of the user's acceptance of the credit.
- * @enum {string}
- */
- readonly state: "accepted" | "declined" | "pending";
- };
- /** @description A repository security advisory. */
- readonly "repository-advisory": {
- /** @description The GitHub Security Advisory ID. */
- readonly ghsa_id: string;
- /** @description The Common Vulnerabilities and Exposures (CVE) ID. */
- readonly cve_id: string | null;
+ readonly forks_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
+ readonly git_commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
+ readonly git_refs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
+ readonly git_tags_url: string;
+ /** @example git:github.com/octocat/Hello-World.git */
+ readonly git_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
+ readonly issue_comment_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
+ readonly issue_events_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
+ readonly issues_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
+ readonly keys_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
+ readonly labels_url: string;
/**
* Format: uri
- * @description The API URL for the advisory.
+ * @example http://api.github.com/repos/octocat/Hello-World/languages
*/
- readonly url: string;
+ readonly languages_url: string;
/**
* Format: uri
- * @description The URL for the advisory.
- */
- readonly html_url: string;
- /** @description A short summary of the advisory. */
- readonly summary: string;
- /** @description A detailed description of what the advisory entails. */
- readonly description: string | null;
- /**
- * @description The severity of the advisory.
- * @enum {string|null}
+ * @example http://api.github.com/repos/octocat/Hello-World/merges
*/
- readonly severity: "critical" | "high" | "medium" | "low";
- /** @description The author of the advisory. */
- readonly author: components["schemas"]["simple-user"] | null;
- /** @description The publisher of the advisory. */
- readonly publisher: components["schemas"]["simple-user"] | null;
- readonly identifiers: {
- /**
- * @description The type of identifier.
- * @enum {string}
- */
- readonly type: "CVE" | "GHSA";
- /** @description The identifier value. */
- readonly value: string;
- }[];
+ readonly merges_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
+ readonly milestones_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
+ readonly notifications_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
+ readonly pulls_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
+ readonly releases_url: string;
+ /** @example git@github.com:octocat/Hello-World.git */
+ readonly ssh_url: string;
/**
- * @description The state of the advisory.
- * @enum {string}
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/stargazers
*/
- readonly state: "published" | "closed" | "withdrawn" | "draft" | "triage";
+ readonly stargazers_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
+ readonly statuses_url: string;
/**
- * Format: date-time
- * @description The date and time of when the advisory was created, in ISO 8601 format.
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscribers
*/
- readonly created_at: string | null;
+ readonly subscribers_url: string;
/**
- * Format: date-time
- * @description The date and time of when the advisory was last updated, in ISO 8601 format.
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscription
*/
- readonly updated_at: string | null;
+ readonly subscription_url: string;
/**
- * Format: date-time
- * @description The date and time of when the advisory was published, in ISO 8601 format.
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/tags
*/
- readonly published_at: string | null;
+ readonly tags_url: string;
/**
- * Format: date-time
- * @description The date and time of when the advisory was closed, in ISO 8601 format.
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/teams
*/
- readonly closed_at: string | null;
+ readonly teams_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
+ readonly trees_url: string;
+ /** @example https://github.com/octocat/Hello-World.git */
+ readonly clone_url: string;
/**
- * Format: date-time
- * @description The date and time of when the advisory was withdrawn, in ISO 8601 format.
+ * Format: uri
+ * @example git:git.example.com/octocat/Hello-World
*/
- readonly withdrawn_at: string | null;
- readonly submission: {
- /** @description Whether a private vulnerability report was accepted by the repository's administrators. */
- readonly accepted: boolean;
- } | null;
- readonly vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null;
- readonly cvss: {
- /** @description The CVSS vector. */
- readonly vector_string: string | null;
- /** @description The CVSS score. */
- readonly score: number | null;
- } | null;
- readonly cwes: {
- /** @description The Common Weakness Enumeration (CWE) identifier. */
- readonly cwe_id: string;
- /** @description The name of the CWE. */
- readonly name: string;
- }[] | null;
- /** @description A list of only the CWE IDs. */
- readonly cwe_ids: string[] | null;
- readonly credits: {
- /** @description The username of the user credited. */
- readonly login?: string;
- readonly type?: components["schemas"]["security-advisory-credit-types"];
- }[] | null;
- readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null;
- /** @description A list of users that collaborate on the advisory. */
- readonly collaborating_users: components["schemas"]["simple-user"][] | null;
- /** @description A list of teams that collaborate on the advisory. */
- readonly collaborating_teams: components["schemas"]["team"][] | null;
- /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */
- readonly private_fork: components["schemas"]["simple-repository"] | null;
- };
- /**
- * Team Simple
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly "team-simple": {
+ readonly mirror_url: string | null;
/**
- * @description Unique identifier of the team
- * @example 1
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/hooks
*/
- readonly id: number;
- /** @example MDQ6VGVhbTE= */
- readonly node_id: string;
+ readonly hooks_url: string;
/**
* Format: uri
- * @description URL for the team
- * @example https://api.github.com/organizations/1/team/1
+ * @example https://svn.github.com/octocat/Hello-World
*/
- readonly url: string;
- /** @example https://api.github.com/organizations/1/team/1/members{/member} */
- readonly members_url: string;
+ readonly svn_url: string;
/**
- * @description Name of the team
- * @example Justice League
+ * Format: uri
+ * @example https://github.com
*/
- readonly name: string;
+ readonly homepage: string | null;
+ readonly language: string | null;
+ /** @example 9 */
+ readonly forks_count: number;
+ /** @example 80 */
+ readonly stargazers_count: number;
+ /** @example 80 */
+ readonly watchers_count: number;
/**
- * @description Description of the team
- * @example A great team.
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @example 108
*/
- readonly description: string | null;
+ readonly size: number;
/**
- * @description Permission that the team will have for its repositories
- * @example admin
+ * @description The default branch of the repository.
+ * @example master
*/
- readonly permission: string;
+ readonly default_branch: string;
+ /** @example 0 */
+ readonly open_issues_count: number;
/**
- * @description The level of privacy this team should have
- * @example closed
+ * @description Whether this repository acts as a template that can be used to generate new repositories.
+ * @default false
+ * @example true
*/
- readonly privacy?: string;
+ readonly is_template: boolean;
+ readonly topics?: string[];
/**
- * @description The notification setting the team has set
- * @example notifications_enabled
+ * @description Whether issues are enabled.
+ * @default true
+ * @example true
*/
- readonly notification_setting?: string;
+ readonly has_issues: boolean;
/**
- * Format: uri
- * @example https://github.com/orgs/rails/teams/core
+ * @description Whether projects are enabled.
+ * @default true
+ * @example true
*/
- readonly html_url: string;
+ readonly has_projects: boolean;
/**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/1/repos
+ * @description Whether the wiki is enabled.
+ * @default true
+ * @example true
*/
- readonly repositories_url: string;
- /** @example justice-league */
- readonly slug: string;
+ readonly has_wiki: boolean;
+ readonly has_pages: boolean;
/**
- * @description Distinguished Name (DN) that team maps to within LDAP environment
- * @example uid=example,ou=users,dc=github,dc=com
+ * @deprecated
+ * @description Whether downloads are enabled.
+ * @default true
+ * @example true
*/
- readonly ldap_dn?: string;
- };
- readonly "actions-billing-usage": {
- /** @description The sum of the free and paid GitHub Actions minutes used. */
- readonly total_minutes_used: number;
- /** @description The total paid GitHub Actions minutes used. */
- readonly total_paid_minutes_used: number;
- /** @description The amount of free GitHub Actions minutes available. */
- readonly included_minutes: number;
- readonly minutes_used_breakdown: {
- /** @description Total minutes used on Ubuntu runner machines. */
- readonly UBUNTU?: number;
- /** @description Total minutes used on macOS runner machines. */
- readonly MACOS?: number;
- /** @description Total minutes used on Windows runner machines. */
- readonly WINDOWS?: number;
- /** @description Total minutes used on Ubuntu 4 core runner machines. */
- readonly ubuntu_4_core?: number;
- /** @description Total minutes used on Ubuntu 8 core runner machines. */
- readonly ubuntu_8_core?: number;
- /** @description Total minutes used on Ubuntu 16 core runner machines. */
- readonly ubuntu_16_core?: number;
- /** @description Total minutes used on Ubuntu 32 core runner machines. */
- readonly ubuntu_32_core?: number;
- /** @description Total minutes used on Ubuntu 64 core runner machines. */
- readonly ubuntu_64_core?: number;
- /** @description Total minutes used on Windows 4 core runner machines. */
- readonly windows_4_core?: number;
- /** @description Total minutes used on Windows 8 core runner machines. */
- readonly windows_8_core?: number;
- /** @description Total minutes used on Windows 16 core runner machines. */
- readonly windows_16_core?: number;
- /** @description Total minutes used on Windows 32 core runner machines. */
- readonly windows_32_core?: number;
- /** @description Total minutes used on Windows 64 core runner machines. */
- readonly windows_64_core?: number;
- /** @description Total minutes used on macOS 12 core runner machines. */
- readonly macos_12_core?: number;
- /** @description Total minutes used on all runner machines. */
- readonly total?: number;
- };
- };
- readonly "packages-billing-usage": {
- /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */
- readonly total_gigabytes_bandwidth_used: number;
- /** @description Total paid storage space (GB) for GitHuub Packages. */
- readonly total_paid_gigabytes_bandwidth_used: number;
- /** @description Free storage space (GB) for GitHub Packages. */
- readonly included_gigabytes_bandwidth: number;
- };
- readonly "combined-billing-usage": {
- /** @description Numbers of days left in billing cycle. */
- readonly days_left_in_billing_cycle: number;
- /** @description Estimated storage space (GB) used in billing cycle. */
- readonly estimated_paid_storage_for_month: number;
- /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */
- readonly estimated_storage_for_month: number;
- };
- /**
- * Team Organization
- * @description Team Organization
- */
- readonly "team-organization": {
- /** @example github */
- readonly login: string;
- /** @example 1 */
- readonly id: number;
- /** @example MDEyOk9yZ2FuaXphdGlvbjE= */
- readonly node_id: string;
+ readonly has_downloads: boolean;
/**
- * Format: uri
- * @example https://api.github.com/orgs/github
+ * @description Whether discussions are enabled.
+ * @default false
+ * @example true
*/
- readonly url: string;
+ readonly has_discussions: boolean;
/**
- * Format: uri
- * @example https://api.github.com/orgs/github/repos
+ * @description Whether the repository is archived.
+ * @default false
*/
- readonly repos_url: string;
+ readonly archived: boolean;
+ /** @description Returns whether or not this repository disabled. */
+ readonly disabled: boolean;
/**
- * Format: uri
- * @example https://api.github.com/orgs/github/events
+ * @description The repository visibility: public, private, or internal.
+ * @default public
*/
- readonly events_url: string;
- /** @example https://api.github.com/orgs/github/hooks */
- readonly hooks_url: string;
- /** @example https://api.github.com/orgs/github/issues */
- readonly issues_url: string;
- /** @example https://api.github.com/orgs/github/members{/member} */
- readonly members_url: string;
- /** @example https://api.github.com/orgs/github/public_members{/member} */
- readonly public_members_url: string;
- /** @example https://github.com/images/error/octocat_happy.gif */
- readonly avatar_url: string;
- /** @example A great organization */
- readonly description: string | null;
- /** @example github */
- readonly name?: string;
- /** @example GitHub */
- readonly company?: string;
+ readonly visibility: string;
/**
- * Format: uri
- * @example https://github.com/blog
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
*/
- readonly blog?: string;
- /** @example San Francisco */
- readonly location?: string;
+ readonly pushed_at: string | null;
/**
- * Format: email
- * @example octocat@github.com
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
*/
- readonly email?: string;
- /** @example github */
- readonly twitter_username?: string | null;
- /** @example true */
- readonly is_verified?: boolean;
- /** @example true */
- readonly has_organization_projects: boolean;
- /** @example true */
- readonly has_repository_projects: boolean;
- /** @example 2 */
- readonly public_repos: number;
- /** @example 1 */
- readonly public_gists: number;
- /** @example 20 */
- readonly followers: number;
- /** @example 0 */
- readonly following: number;
+ readonly created_at: string | null;
/**
- * Format: uri
- * @example https://github.com/octocat
+ * Format: date-time
+ * @example 2011-01-26T19:14:43Z
*/
- readonly html_url: string;
+ readonly updated_at: string | null;
/**
- * Format: date-time
- * @example 2008-01-14T04:33:35Z
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ * @example true
*/
- readonly created_at: string;
- /** @example Organization */
- readonly type: string;
- /** @example 100 */
- readonly total_private_repos?: number;
- /** @example 100 */
- readonly owned_private_repos?: number;
- /** @example 81 */
- readonly private_gists?: number | null;
- /** @example 10000 */
- readonly disk_usage?: number | null;
- /** @example 8 */
- readonly collaborators?: number | null;
+ readonly allow_rebase_merge: boolean;
+ readonly temp_clone_token?: string;
/**
- * Format: email
- * @example org@example.com
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ * @example true
*/
- readonly billing_email?: string | null;
- readonly plan?: {
- readonly name: string;
- readonly space: number;
- readonly private_repos: number;
- readonly filled_seats?: number;
- readonly seats?: number;
- };
- readonly default_repository_permission?: string | null;
- /** @example true */
- readonly members_can_create_repositories?: boolean | null;
- /** @example true */
- readonly two_factor_requirement_enabled?: boolean | null;
- /** @example all */
- readonly members_allowed_repository_creation_type?: string;
- /** @example true */
- readonly members_can_create_public_repositories?: boolean;
- /** @example true */
- readonly members_can_create_private_repositories?: boolean;
- /** @example true */
- readonly members_can_create_internal_repositories?: boolean;
- /** @example true */
- readonly members_can_create_pages?: boolean;
- /** @example true */
- readonly members_can_create_public_pages?: boolean;
- /** @example true */
- readonly members_can_create_private_pages?: boolean;
- /** @example false */
- readonly members_can_fork_private_repositories?: boolean | null;
- /** @example false */
- readonly web_commit_signoff_required?: boolean;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: date-time */
- readonly archived_at: string | null;
- };
- /**
- * Full Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly "team-full": {
+ readonly allow_squash_merge: boolean;
/**
- * @description Unique identifier of the team
- * @example 42
+ * @description Whether to allow Auto-merge to be used on pull requests.
+ * @default false
+ * @example false
*/
- readonly id: number;
- /** @example MDQ6VGVhbTE= */
- readonly node_id: string;
+ readonly allow_auto_merge: boolean;
/**
- * Format: uri
- * @description URL for the team
- * @example https://api.github.com/organizations/1/team/1
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ * @example false
*/
- readonly url: string;
+ readonly delete_branch_on_merge: boolean;
/**
- * Format: uri
- * @example https://github.com/orgs/rails/teams/core
+ * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
+ * @default false
+ * @example false
*/
- readonly html_url: string;
+ readonly allow_update_branch: boolean;
/**
- * @description Name of the team
- * @example Developers
+ * @deprecated
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
*/
- readonly name: string;
- /** @example justice-league */
- readonly slug: string;
- /** @example A great team. */
- readonly description: string | null;
+ readonly use_squash_pr_title_as_default: boolean;
/**
- * @description The level of privacy this team should have
- * @example closed
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
* @enum {string}
*/
- readonly privacy?: "closed" | "secret";
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
- * @description The notification setting the team has set
- * @example notifications_enabled
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /**
- * @description Permission that the team will have for its repositories
- * @example push
- */
- readonly permission: string;
- /** @example https://api.github.com/organizations/1/team/1/members{/member} */
- readonly members_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/1/repos
- */
- readonly repositories_url: string;
- readonly parent?: components["schemas"]["nullable-team-simple"];
- /** @example 3 */
- readonly members_count: number;
- /** @example 10 */
- readonly repos_count: number;
- /**
- * Format: date-time
- * @example 2017-07-14T16:53:42Z
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @example 2017-08-17T12:37:15Z
- */
- readonly updated_at: string;
- readonly organization: components["schemas"]["team-organization"];
- /**
- * @description Distinguished Name (DN) that team maps to within LDAP environment
- * @example uid=example,ou=users,dc=github,dc=com
- */
- readonly ldap_dn?: string;
- };
- /**
- * Team Discussion
- * @description A team discussion is a persistent record of a free-form conversation within a team.
- */
- readonly "team-discussion": {
- readonly author: components["schemas"]["nullable-simple-user"];
- /**
- * @description The main text of the discussion.
- * @example Please suggest improvements to our workflow in comments.
- */
- readonly body: string;
- /** @example Hi! This is an area for us to collaborate as a team
*/
- readonly body_html: string;
- /**
- * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
- * @example 0307116bbf7ced493b8d8a346c650b71
- */
- readonly body_version: string;
- /** @example 0 */
- readonly comments_count: number;
- /**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments
- */
- readonly comments_url: string;
- /**
- * Format: date-time
- * @example 2018-01-25T18:56:31Z
- */
- readonly created_at: string;
- /** Format: date-time */
- readonly last_edited_at: string | null;
- /**
- * Format: uri
- * @example https://github.com/orgs/github/teams/justice-league/discussions/1
- */
- readonly html_url: string;
- /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */
- readonly node_id: string;
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
- * @description The unique sequence number of a team discussion.
- * @example 42
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
*/
- readonly number: number;
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
- * @description Whether or not this discussion should be pinned for easy retrieval.
- * @example true
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
*/
- readonly pinned: boolean;
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
- * @description Whether or not this discussion should be restricted to team members and organization owners.
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
* @example true
*/
- readonly private: boolean;
- /**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2343027
- */
- readonly team_url: string;
- /**
- * @description The title of the discussion.
- * @example How can we improve our workflow?
- */
- readonly title: string;
- /**
- * Format: date-time
- * @example 2018-01-25T18:56:31Z
- */
- readonly updated_at: string;
+ readonly allow_merge_commit: boolean;
+ /** @description Whether to allow forking this repo */
+ readonly allow_forking?: boolean;
/**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2343027/discussions/1
+ * @description Whether to require contributors to sign off on web-based commits
+ * @default false
*/
- readonly url: string;
- readonly reactions?: components["schemas"]["reaction-rollup"];
- };
+ readonly web_commit_signoff_required: boolean;
+ readonly open_issues: number;
+ readonly watchers: number;
+ readonly master_branch?: string;
+ /** @example "2020-07-09T00:17:42Z" */
+ readonly starred_at?: string;
+ /** @description Whether anonymous git access is enabled for this repository */
+ readonly anonymous_access_enabled?: boolean;
+ } | null;
/**
- * Team Discussion Comment
- * @description A reply to a discussion within a team.
+ * Code Of Conduct Simple
+ * @description Code of Conduct Simple
*/
- readonly "team-discussion-comment": {
- readonly author: components["schemas"]["nullable-simple-user"];
- /**
- * @description The main text of the comment.
- * @example I agree with this suggestion.
- */
- readonly body: string;
- /** @example Do you like apples?
*/
- readonly body_html: string;
- /**
- * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
- * @example 0307116bbf7ced493b8d8a346c650b71
- */
- readonly body_version: string;
- /**
- * Format: date-time
- * @example 2018-01-15T23:53:58Z
- */
- readonly created_at: string;
- /** Format: date-time */
- readonly last_edited_at: string | null;
- /**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2403582/discussions/1
- */
- readonly discussion_url: string;
- /**
- * Format: uri
- * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- */
- readonly html_url: string;
- /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */
- readonly node_id: string;
- /**
- * @description The unique sequence number of a team discussion comment.
- * @example 42
- */
- readonly number: number;
- /**
- * Format: date-time
- * @example 2018-01-15T23:53:58Z
- */
- readonly updated_at: string;
+ readonly "code-of-conduct-simple": {
/**
* Format: uri
- * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- */
- readonly url: string;
- readonly reactions?: components["schemas"]["reaction-rollup"];
- };
- /**
- * Reaction
- * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively.
- */
- readonly reaction: {
- /** @example 1 */
- readonly id: number;
- /** @example MDg6UmVhY3Rpb24x */
- readonly node_id: string;
- readonly user: components["schemas"]["nullable-simple-user"];
- /**
- * @description The reaction to use
- * @example heart
- * @enum {string}
- */
- readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
- /**
- * Format: date-time
- * @example 2016-05-20T20:09:31Z
+ * @example https://api.github.com/repos/github/docs/community/code_of_conduct
*/
- readonly created_at: string;
- };
- /**
- * Team Membership
- * @description Team Membership
- */
- readonly "team-membership": {
- /** Format: uri */
readonly url: string;
+ /** @example citizen_code_of_conduct */
+ readonly key: string;
+ /** @example Citizen Code of Conduct */
+ readonly name: string;
/**
- * @description The role of the user in the team.
- * @default member
- * @example member
- * @enum {string}
- */
- readonly role: "member" | "maintainer";
- /**
- * @description The state of the user's membership in the team.
- * @enum {string}
+ * Format: uri
+ * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
*/
- readonly state: "active" | "pending";
- };
- /**
- * Team Project
- * @description A team's access to a project.
- */
- readonly "team-project": {
- readonly owner_url: string;
- readonly url: string;
- readonly html_url: string;
- readonly columns_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly name: string;
- readonly body: string | null;
- readonly number: number;
- readonly state: string;
- readonly creator: components["schemas"]["simple-user"];
- readonly created_at: string;
- readonly updated_at: string;
- /** @description The organization permission for this project. Only present when owner is an organization. */
- readonly organization_permission?: string;
- /** @description Whether the project is private or not. Only present when owner is an organization. */
- readonly private?: boolean;
- readonly permissions: {
- readonly read: boolean;
- readonly write: boolean;
- readonly admin: boolean;
- };
+ readonly html_url: string | null;
};
/**
- * Team Repository
- * @description A team's access to a repository.
+ * Full Repository
+ * @description Full Repository
*/
- readonly "team-repository": {
- /**
- * @description Unique identifier of the repository
- * @example 42
- */
+ readonly "full-repository": {
+ /** @example 1296269 */
readonly id: number;
/** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
readonly node_id: string;
- /**
- * @description The name of the repository.
- * @example Team Environment
- */
+ /** @example Hello-World */
readonly name: string;
/** @example octocat/Hello-World */
readonly full_name: string;
- readonly license: components["schemas"]["nullable-license-simple"];
- readonly forks: number;
- readonly permissions?: {
- readonly admin: boolean;
- readonly pull: boolean;
- readonly triage?: boolean;
- readonly push: boolean;
- readonly maintain?: boolean;
- };
- /** @example admin */
- readonly role_name?: string;
- readonly owner: components["schemas"]["nullable-simple-user"];
- /**
- * @description Whether the repository is private or public.
- * @default false
- */
+ readonly owner: components["schemas"]["simple-user"];
readonly private: boolean;
/**
* Format: uri
@@ -22761,790 +22804,1375 @@ export type components = {
readonly stargazers_count: number;
/** @example 80 */
readonly watchers_count: number;
- /** @example 108 */
- readonly size: number;
/**
- * @description The default branch of the repository.
- * @example master
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @example 108
*/
+ readonly size: number;
+ /** @example master */
readonly default_branch: string;
/** @example 0 */
readonly open_issues_count: number;
- /**
- * @description Whether this repository acts as a template that can be used to generate new repositories.
- * @default false
- * @example true
- */
- readonly is_template: boolean;
+ /** @example true */
+ readonly is_template?: boolean;
+ /** @example [
+ * "octocat",
+ * "atom",
+ * "electron",
+ * "API"
+ * ] */
readonly topics?: string[];
- /**
- * @description Whether issues are enabled.
- * @default true
- * @example true
- */
+ /** @example true */
readonly has_issues: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- * @example true
- */
+ /** @example true */
readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- * @example true
- */
+ /** @example true */
readonly has_wiki: boolean;
readonly has_pages: boolean;
- /**
- * @description Whether downloads are enabled.
- * @default true
- * @example true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
+ /** @example true */
+ readonly has_downloads?: boolean;
+ /** @example true */
+ readonly has_discussions: boolean;
readonly archived: boolean;
/** @description Returns whether or not this repository disabled. */
readonly disabled: boolean;
/**
* @description The repository visibility: public, private, or internal.
- * @default public
+ * @example public
*/
- readonly visibility: string;
+ readonly visibility?: string;
/**
* Format: date-time
* @example 2011-01-26T19:06:43Z
*/
- readonly pushed_at: string | null;
+ readonly pushed_at: string;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- readonly created_at: string | null;
+ readonly created_at: string;
/**
* Format: date-time
* @example 2011-01-26T19:14:43Z
*/
- readonly updated_at: string | null;
+ readonly updated_at: string;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
+ readonly pull: boolean;
+ };
+ /** @example true */
+ readonly allow_rebase_merge?: boolean;
+ readonly template_repository?: components["schemas"]["nullable-repository"];
+ readonly temp_clone_token?: string | null;
+ /** @example true */
+ readonly allow_squash_merge?: boolean;
+ /** @example false */
+ readonly allow_auto_merge?: boolean;
+ /** @example false */
+ readonly delete_branch_on_merge?: boolean;
+ /** @example true */
+ readonly allow_merge_commit?: boolean;
+ /** @example true */
+ readonly allow_update_branch?: boolean;
+ /** @example false */
+ readonly use_squash_pr_title_as_default?: boolean;
/**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- * @example true
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @example PR_TITLE
+ * @enum {string}
*/
- readonly allow_rebase_merge: boolean;
- readonly temp_clone_token?: string;
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- * @example true
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @example PR_BODY
+ * @enum {string}
*/
- readonly allow_squash_merge: boolean;
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
- * @description Whether to allow Auto-merge to be used on pull requests.
- * @default false
- * @example false
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @example PR_TITLE
+ * @enum {string}
*/
- readonly allow_auto_merge: boolean;
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- * @example false
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @example PR_BODY
+ * @enum {string}
*/
- readonly delete_branch_on_merge: boolean;
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /** @example true */
+ readonly allow_forking?: boolean;
+ /** @example false */
+ readonly web_commit_signoff_required?: boolean;
+ /** @example 42 */
+ readonly subscribers_count: number;
+ /** @example 0 */
+ readonly network_count: number;
+ readonly license: components["schemas"]["nullable-license-simple"];
+ readonly organization?: components["schemas"]["nullable-simple-user"];
+ readonly parent?: components["schemas"]["repository"];
+ readonly source?: components["schemas"]["repository"];
+ readonly forks: number;
+ readonly master_branch?: string;
+ readonly open_issues: number;
+ readonly watchers: number;
/**
- * @description Whether to allow merge commits for pull requests.
+ * @description Whether anonymous git access is allowed.
* @default true
- * @example true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow forking this repo
- * @default false
- * @example false
*/
- readonly allow_forking: boolean;
- /**
- * @description Whether to require contributors to sign off on web-based commits
- * @default false
- * @example false
- */
- readonly web_commit_signoff_required: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
- readonly open_issues: number;
- readonly watchers: number;
- readonly master_branch?: string;
+ readonly anonymous_access_enabled: boolean;
+ readonly code_of_conduct?: components["schemas"]["code-of-conduct-simple"];
+ readonly security_and_analysis?: components["schemas"]["security-and-analysis"];
+ /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
+ readonly custom_properties?: {
+ readonly [key: string]: unknown;
+ };
};
/**
- * Project Card
- * @description Project cards represent a scope of work.
+ * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).
+ * @enum {string}
*/
- readonly "project-card": {
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/cards/1478
- */
- readonly url: string;
- /**
- * @description The project card's ID
- * @example 42
- */
- readonly id: number;
- /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */
- readonly node_id: string;
- /** @example Add payload for delete Project column */
- readonly note: string | null;
- readonly creator: components["schemas"]["nullable-simple-user"];
+ readonly "repository-rule-enforcement": "disabled" | "active" | "evaluate";
+ /**
+ * Repository Ruleset Bypass Actor
+ * @description An actor that can bypass rules in a ruleset
+ */
+ readonly "repository-ruleset-bypass-actor": {
+ /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.
+ * */
+ readonly actor_id?: number | null;
/**
- * Format: date-time
- * @example 2016-09-05T14:21:06Z
+ * @description The type of actor that can bypass a ruleset.
+ *
+ * @enum {string}
*/
- readonly created_at: string;
+ readonly actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey";
/**
- * Format: date-time
- * @example 2016-09-05T14:20:22Z
+ * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.
+ *
+ * @enum {string}
*/
- readonly updated_at: string;
- /**
- * @description Whether or not the card is archived
- * @example false
- */
- readonly archived?: boolean;
- readonly column_name?: string;
- readonly project_id?: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/367
- */
- readonly column_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/repos/api-playground/projects-test/issues/3
- */
- readonly content_url?: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/120
- */
- readonly project_url: string;
+ readonly bypass_mode: "always" | "pull_request";
};
/**
- * Project Column
- * @description Project columns contain cards of work.
+ * Repository ruleset conditions for ref names
+ * @description Parameters for a repository ruleset ref name condition
*/
- readonly "project-column": {
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/367
- */
- readonly url: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/120
- */
- readonly project_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/367/cards
- */
- readonly cards_url: string;
- /**
- * @description The unique identifier of the project column
- * @example 42
- */
- readonly id: number;
- /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */
- readonly node_id: string;
- /**
- * @description Name of the project column
- * @example Remaining tasks
- */
+ readonly "repository-ruleset-conditions": {
+ readonly ref_name?: {
+ /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */
+ readonly include?: string[];
+ /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */
+ readonly exclude?: string[];
+ };
+ };
+ /**
+ * Repository ruleset conditions for repository names
+ * @description Parameters for a repository name condition
+ */
+ readonly "repository-ruleset-conditions-repository-name-target": {
+ readonly repository_name: {
+ /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */
+ readonly include?: string[];
+ /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */
+ readonly exclude?: string[];
+ /** @description Whether renaming of target repositories is prevented. */
+ readonly protected?: boolean;
+ };
+ };
+ /**
+ * Repository ruleset conditions for repository IDs
+ * @description Parameters for a repository ID condition
+ */
+ readonly "repository-ruleset-conditions-repository-id-target": {
+ readonly repository_id: {
+ /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */
+ readonly repository_ids?: number[];
+ };
+ };
+ /**
+ * Repository ruleset property targeting definition
+ * @description Parameters for a targeting a repository property
+ */
+ readonly "repository-ruleset-conditions-repository-property-spec": {
+ /** @description The name of the repository property to target */
readonly name: string;
- /**
- * Format: date-time
- * @example 2016-09-05T14:18:44Z
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @example 2016-09-05T14:22:28Z
- */
- readonly updated_at: string;
+ /** @description The values to match for the repository property */
+ readonly property_values: string[];
};
/**
- * Project Collaborator Permission
- * @description Project Collaborator Permission
+ * Repository ruleset conditions for repository properties
+ * @description Parameters for a repository property condition
*/
- readonly "project-collaborator-permission": {
- readonly permission: string;
- readonly user: components["schemas"]["nullable-simple-user"];
+ readonly "repository-ruleset-conditions-repository-property-target": {
+ readonly repository_property: {
+ /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */
+ readonly include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][];
+ /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */
+ readonly exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][];
+ };
};
- /** Rate Limit */
- readonly "rate-limit": {
- readonly limit: number;
- readonly remaining: number;
- readonly reset: number;
- readonly used: number;
+ /**
+ * Organization ruleset conditions
+ * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.
+ *
+ */
+ readonly "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]);
+ /**
+ * creation
+ * @description Only allow users with bypass permission to create matching refs.
+ */
+ readonly "repository-rule-creation": {
+ /** @enum {string} */
+ readonly type: "creation";
};
/**
- * Rate Limit Overview
- * @description Rate Limit Overview
+ * update
+ * @description Only allow users with bypass permission to update matching refs.
*/
- readonly "rate-limit-overview": {
- readonly resources: {
- readonly core: components["schemas"]["rate-limit"];
- readonly graphql?: components["schemas"]["rate-limit"];
- readonly search: components["schemas"]["rate-limit"];
- readonly code_search?: components["schemas"]["rate-limit"];
- readonly source_import?: components["schemas"]["rate-limit"];
- readonly integration_manifest?: components["schemas"]["rate-limit"];
- readonly code_scanning_upload?: components["schemas"]["rate-limit"];
- readonly actions_runner_registration?: components["schemas"]["rate-limit"];
- readonly scim?: components["schemas"]["rate-limit"];
- readonly dependency_snapshots?: components["schemas"]["rate-limit"];
+ readonly "repository-rule-update": {
+ /** @enum {string} */
+ readonly type: "update";
+ readonly parameters?: {
+ /** @description Branch can pull changes from its upstream repository */
+ readonly update_allows_fetch_and_merge: boolean;
};
- readonly rate: components["schemas"]["rate-limit"];
};
/**
- * Repository
- * @description A repository on GitHub.
+ * deletion
+ * @description Only allow users with bypass permissions to delete matching refs.
*/
- readonly "nullable-repository": {
+ readonly "repository-rule-deletion": {
+ /** @enum {string} */
+ readonly type: "deletion";
+ };
+ /**
+ * required_linear_history
+ * @description Prevent merge commits from being pushed to matching refs.
+ */
+ readonly "repository-rule-required-linear-history": {
+ /** @enum {string} */
+ readonly type: "required_linear_history";
+ };
+ /**
+ * required_deployments
+ * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
+ */
+ readonly "repository-rule-required-deployments": {
+ /** @enum {string} */
+ readonly type: "required_deployments";
+ readonly parameters?: {
+ /** @description The environments that must be successfully deployed to before branches can be merged. */
+ readonly required_deployment_environments: string[];
+ };
+ };
+ /**
+ * required_signatures
+ * @description Commits pushed to matching refs must have verified signatures.
+ */
+ readonly "repository-rule-required-signatures": {
+ /** @enum {string} */
+ readonly type: "required_signatures";
+ };
+ /**
+ * pull_request
+ * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
+ */
+ readonly "repository-rule-pull-request": {
+ /** @enum {string} */
+ readonly type: "pull_request";
+ readonly parameters?: {
+ /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */
+ readonly dismiss_stale_reviews_on_push: boolean;
+ /** @description Require an approving review in pull requests that modify files that have a designated code owner. */
+ readonly require_code_owner_review: boolean;
+ /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */
+ readonly require_last_push_approval: boolean;
+ /** @description The number of approving reviews that are required before a pull request can be merged. */
+ readonly required_approving_review_count: number;
+ /** @description All conversations on code must be resolved before a pull request can be merged. */
+ readonly required_review_thread_resolution: boolean;
+ };
+ };
+ /**
+ * StatusCheckConfiguration
+ * @description Required status check
+ */
+ readonly "repository-rule-params-status-check-configuration": {
+ /** @description The status check context name that must be present on the commit. */
+ readonly context: string;
+ /** @description The optional integration ID that this status check must originate from. */
+ readonly integration_id?: number;
+ };
+ /**
+ * required_status_checks
+ * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
+ */
+ readonly "repository-rule-required-status-checks": {
+ /** @enum {string} */
+ readonly type: "required_status_checks";
+ readonly parameters?: {
+ /** @description Status checks that are required. */
+ readonly required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][];
+ /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */
+ readonly strict_required_status_checks_policy: boolean;
+ };
+ };
+ /**
+ * non_fast_forward
+ * @description Prevent users with push access from force pushing to refs.
+ */
+ readonly "repository-rule-non-fast-forward": {
+ /** @enum {string} */
+ readonly type: "non_fast_forward";
+ };
+ /**
+ * commit_message_pattern
+ * @description Parameters to be used for the commit_message_pattern rule
+ */
+ readonly "repository-rule-commit-message-pattern": {
+ /** @enum {string} */
+ readonly type: "commit_message_pattern";
+ readonly parameters?: {
+ /** @description How this rule will appear to users. */
+ readonly name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ readonly negate?: boolean;
+ /**
+ * @description The operator to use for matching.
+ * @enum {string}
+ */
+ readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ readonly pattern: string;
+ };
+ };
+ /**
+ * commit_author_email_pattern
+ * @description Parameters to be used for the commit_author_email_pattern rule
+ */
+ readonly "repository-rule-commit-author-email-pattern": {
+ /** @enum {string} */
+ readonly type: "commit_author_email_pattern";
+ readonly parameters?: {
+ /** @description How this rule will appear to users. */
+ readonly name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ readonly negate?: boolean;
+ /**
+ * @description The operator to use for matching.
+ * @enum {string}
+ */
+ readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ readonly pattern: string;
+ };
+ };
+ /**
+ * committer_email_pattern
+ * @description Parameters to be used for the committer_email_pattern rule
+ */
+ readonly "repository-rule-committer-email-pattern": {
+ /** @enum {string} */
+ readonly type: "committer_email_pattern";
+ readonly parameters?: {
+ /** @description How this rule will appear to users. */
+ readonly name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ readonly negate?: boolean;
+ /**
+ * @description The operator to use for matching.
+ * @enum {string}
+ */
+ readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ readonly pattern: string;
+ };
+ };
+ /**
+ * branch_name_pattern
+ * @description Parameters to be used for the branch_name_pattern rule
+ */
+ readonly "repository-rule-branch-name-pattern": {
+ /** @enum {string} */
+ readonly type: "branch_name_pattern";
+ readonly parameters?: {
+ /** @description How this rule will appear to users. */
+ readonly name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ readonly negate?: boolean;
+ /**
+ * @description The operator to use for matching.
+ * @enum {string}
+ */
+ readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ readonly pattern: string;
+ };
+ };
+ /**
+ * tag_name_pattern
+ * @description Parameters to be used for the tag_name_pattern rule
+ */
+ readonly "repository-rule-tag-name-pattern": {
+ /** @enum {string} */
+ readonly type: "tag_name_pattern";
+ readonly parameters?: {
+ /** @description How this rule will appear to users. */
+ readonly name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ readonly negate?: boolean;
+ /**
+ * @description The operator to use for matching.
+ * @enum {string}
+ */
+ readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ readonly pattern: string;
+ };
+ };
+ /**
+ * RestrictedCommits
+ * @description Restricted commit
+ */
+ readonly "repository-rule-params-restricted-commits": {
+ /** @description Full or abbreviated commit hash to reject */
+ readonly oid: string;
+ /** @description Reason for restriction */
+ readonly reason?: string;
+ };
+ /**
+ * WorkflowFileReference
+ * @description A workflow that must run for this rule to pass
+ */
+ readonly "repository-rule-params-workflow-file-reference": {
+ /** @description The path to the workflow file */
+ readonly path: string;
+ /** @description The ref (branch or tag) of the workflow file to use */
+ readonly ref?: string;
+ /** @description The ID of the repository where the workflow is defined */
+ readonly repository_id: number;
+ /** @description The commit SHA of the workflow file to use */
+ readonly sha?: string;
+ };
+ /**
+ * workflows
+ * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
+ */
+ readonly "repository-rule-workflows": {
+ /** @enum {string} */
+ readonly type: "workflows";
+ readonly parameters?: {
+ /** @description Workflows that must pass for this rule to pass. */
+ readonly workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][];
+ };
+ };
+ /**
+ * CodeScanningTool
+ * @description A tool that must provide code scanning results for this rule to pass.
+ */
+ readonly "repository-rule-params-code-scanning-tool": {
/**
- * @description Unique identifier of the repository
- * @example 42
+ * @description The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
+ * @enum {string}
*/
- readonly id: number;
- /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
- readonly node_id: string;
+ readonly alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all";
/**
- * @description The name of the repository.
- * @example Team Environment
+ * @description The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
+ * @enum {string}
*/
- readonly name: string;
- /** @example octocat/Hello-World */
- readonly full_name: string;
- readonly license: components["schemas"]["nullable-license-simple"];
- readonly organization?: components["schemas"]["nullable-simple-user"];
- readonly forks: number;
- readonly permissions?: {
- readonly admin: boolean;
- readonly pull: boolean;
- readonly triage?: boolean;
- readonly push: boolean;
- readonly maintain?: boolean;
+ readonly security_alerts_threshold: "none" | "critical" | "high_or_higher" | "medium_or_higher" | "all";
+ /** @description The name of a code scanning tool */
+ readonly tool: string;
+ };
+ /**
+ * Repository Rule
+ * @description A repository rule.
+ */
+ readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | {
+ /** @enum {string} */
+ readonly type: "file_path_restriction";
+ readonly parameters?: {
+ /** @description The file paths that are restricted from being pushed to the commit graph. */
+ readonly restricted_file_paths: string[];
};
- readonly owner: components["schemas"]["simple-user"];
+ } | {
+ /** @enum {string} */
+ readonly type: "max_file_path_length";
+ readonly parameters?: {
+ /** @description The maximum amount of characters allowed in file paths */
+ readonly max_file_path_length: number;
+ };
+ } | {
+ /** @enum {string} */
+ readonly type: "file_extension_restriction";
+ readonly parameters?: {
+ /** @description The file extensions that are restricted from being pushed to the commit graph. */
+ readonly restricted_file_extensions: string[];
+ };
+ } | {
+ /** @enum {string} */
+ readonly type: "max_file_size";
+ readonly parameters?: {
+ /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */
+ readonly max_file_size: number;
+ };
+ } | components["schemas"]["repository-rule-workflows"];
+ /**
+ * Repository ruleset
+ * @description A set of rules to apply when specified conditions are met.
+ */
+ readonly "repository-ruleset": {
+ /** @description The ID of the ruleset */
+ readonly id: number;
+ /** @description The name of the ruleset */
+ readonly name: string;
/**
- * @description Whether the repository is private or public.
- * @default false
+ * @description The target of the ruleset
+ *
+ * **Note**: The `push` target is in beta and is subject to change.
+ * @enum {string}
*/
- readonly private: boolean;
+ readonly target?: "branch" | "tag" | "push";
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World
+ * @description The type of the source of the ruleset
+ * @enum {string}
*/
- readonly html_url: string;
- /** @example This your first repo! */
- readonly description: string | null;
- readonly fork: boolean;
+ readonly source_type?: "Repository" | "Organization";
+ /** @description The name of the source */
+ readonly source: string;
+ readonly enforcement: components["schemas"]["repository-rule-enforcement"];
+ /** @description The actors that can bypass the rules in this ruleset */
+ readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][];
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World
+ * @description The bypass type of the user making the API request for this ruleset. This field is only returned when
+ * querying the repository-level endpoint.
+ * @enum {string}
*/
- readonly url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
- readonly archive_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
- readonly assignees_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
- readonly blobs_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
- readonly branches_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
- readonly collaborators_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
- readonly comments_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
- readonly commits_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
- readonly compare_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
- readonly contents_url: string;
+ readonly current_user_can_bypass?: "always" | "pull_requests_only" | "never";
+ readonly node_id?: string;
+ readonly _links?: {
+ readonly self?: {
+ /** @description The URL of the ruleset */
+ readonly href?: string;
+ };
+ readonly html?: {
+ /** @description The html URL of the ruleset */
+ readonly href?: string;
+ };
+ };
+ readonly conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null;
+ readonly rules?: components["schemas"]["repository-rule"][];
+ /** Format: date-time */
+ readonly created_at?: string;
+ /** Format: date-time */
+ readonly updated_at?: string;
+ };
+ /**
+ * Rule Suites
+ * @description Response
+ */
+ readonly "rule-suites": {
+ /** @description The unique identifier of the rule insight. */
+ readonly id?: number;
+ /** @description The number that identifies the user. */
+ readonly actor_id?: number;
+ /** @description The handle for the GitHub user account. */
+ readonly actor_name?: string;
+ /** @description The first commit sha before the push evaluation. */
+ readonly before_sha?: string;
+ /** @description The last commit sha in the push evaluation. */
+ readonly after_sha?: string;
+ /** @description The ref name that the evaluation ran on. */
+ readonly ref?: string;
+ /** @description The ID of the repository associated with the rule evaluation. */
+ readonly repository_id?: number;
+ /** @description The name of the repository without the `.git` extension. */
+ readonly repository_name?: string;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/contributors
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
*/
- readonly contributors_url: string;
+ readonly pushed_at?: string;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/deployments
+ * @description The result of the rule evaluations for rules with the `active` enforcement status.
+ * @enum {string}
*/
- readonly deployments_url: string;
+ readonly result?: "pass" | "fail" | "bypass";
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/downloads
+ * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`.
+ * @enum {string}
*/
- readonly downloads_url: string;
+ readonly evaluation_result?: "pass" | "fail";
+ }[];
+ /**
+ * Rule Suite
+ * @description Response
+ */
+ readonly "rule-suite": {
+ /** @description The unique identifier of the rule insight. */
+ readonly id?: number;
+ /** @description The number that identifies the user. */
+ readonly actor_id?: number | null;
+ /** @description The handle for the GitHub user account. */
+ readonly actor_name?: string | null;
+ /** @description The first commit sha before the push evaluation. */
+ readonly before_sha?: string;
+ /** @description The last commit sha in the push evaluation. */
+ readonly after_sha?: string;
+ /** @description The ref name that the evaluation ran on. */
+ readonly ref?: string;
+ /** @description The ID of the repository associated with the rule evaluation. */
+ readonly repository_id?: number;
+ /** @description The name of the repository without the `.git` extension. */
+ readonly repository_name?: string;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/events
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
*/
- readonly events_url: string;
+ readonly pushed_at?: string;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/forks
+ * @description The result of the rule evaluations for rules with the `active` enforcement status.
+ * @enum {string}
*/
- readonly forks_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
- readonly git_commits_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
- readonly git_refs_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
- readonly git_tags_url: string;
- /** @example git:github.com/octocat/Hello-World.git */
- readonly git_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
- readonly issue_comment_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
- readonly issue_events_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
- readonly issues_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
- readonly keys_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
- readonly labels_url: string;
+ readonly result?: "pass" | "fail" | "bypass";
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/languages
+ * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`.
+ * @enum {string}
*/
- readonly languages_url: string;
+ readonly evaluation_result?: "pass" | "fail";
+ /** @description Details on the evaluated rules. */
+ readonly rule_evaluations?: {
+ readonly rule_source?: {
+ /** @description The type of rule source. */
+ readonly type?: string;
+ /** @description The ID of the rule source. */
+ readonly id?: number | null;
+ /** @description The name of the rule source. */
+ readonly name?: string | null;
+ };
+ /**
+ * @description The enforcement level of this rule source.
+ * @enum {string}
+ */
+ readonly enforcement?: "active" | "evaluate" | "deleted ruleset";
+ /**
+ * @description The result of the evaluation of the individual rule.
+ * @enum {string}
+ */
+ readonly result?: "pass" | "fail";
+ /** @description The type of rule. */
+ readonly rule_type?: string;
+ /** @description Any associated details with the rule evaluation. */
+ readonly details?: string;
+ }[];
+ };
+ /** @description A product affected by the vulnerability detailed in a repository security advisory. */
+ readonly "repository-advisory-vulnerability": {
+ /** @description The name of the package affected by the vulnerability. */
+ readonly package: {
+ readonly ecosystem: components["schemas"]["security-advisory-ecosystems"];
+ /** @description The unique package name within its ecosystem. */
+ readonly name: string | null;
+ } | null;
+ /** @description The range of the package versions affected by the vulnerability. */
+ readonly vulnerable_version_range: string | null;
+ /** @description The package version(s) that resolve the vulnerability. */
+ readonly patched_versions: string | null;
+ /** @description The functions in the package that are affected. */
+ readonly vulnerable_functions: string[] | null;
+ };
+ /** @description A credit given to a user for a repository security advisory. */
+ readonly "repository-advisory-credit": {
+ readonly user: components["schemas"]["simple-user"];
+ readonly type: components["schemas"]["security-advisory-credit-types"];
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/merges
+ * @description The state of the user's acceptance of the credit.
+ * @enum {string}
*/
- readonly merges_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
- readonly milestones_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
- readonly notifications_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
- readonly pulls_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
- readonly releases_url: string;
- /** @example git@github.com:octocat/Hello-World.git */
- readonly ssh_url: string;
+ readonly state: "accepted" | "declined" | "pending";
+ };
+ /** @description A repository security advisory. */
+ readonly "repository-advisory": {
+ /** @description The GitHub Security Advisory ID. */
+ readonly ghsa_id: string;
+ /** @description The Common Vulnerabilities and Exposures (CVE) ID. */
+ readonly cve_id: string | null;
/**
* Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/stargazers
+ * @description The API URL for the advisory.
*/
- readonly stargazers_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
- readonly statuses_url: string;
+ readonly url: string;
/**
* Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/subscribers
+ * @description The URL for the advisory.
*/
- readonly subscribers_url: string;
+ readonly html_url: string;
+ /** @description A short summary of the advisory. */
+ readonly summary: string;
+ /** @description A detailed description of what the advisory entails. */
+ readonly description: string | null;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/subscription
+ * @description The severity of the advisory.
+ * @enum {string|null}
*/
- readonly subscription_url: string;
+ readonly severity: "critical" | "high" | "medium" | "low";
+ /** @description The author of the advisory. */
+ readonly author: components["schemas"]["simple-user"] | null;
+ /** @description The publisher of the advisory. */
+ readonly publisher: components["schemas"]["simple-user"] | null;
+ readonly identifiers: {
+ /**
+ * @description The type of identifier.
+ * @enum {string}
+ */
+ readonly type: "CVE" | "GHSA";
+ /** @description The identifier value. */
+ readonly value: string;
+ }[];
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/tags
+ * @description The state of the advisory.
+ * @enum {string}
*/
- readonly tags_url: string;
+ readonly state: "published" | "closed" | "withdrawn" | "draft" | "triage";
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/teams
+ * Format: date-time
+ * @description The date and time of when the advisory was created, in ISO 8601 format.
*/
- readonly teams_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
- readonly trees_url: string;
- /** @example https://github.com/octocat/Hello-World.git */
- readonly clone_url: string;
+ readonly created_at: string | null;
/**
- * Format: uri
- * @example git:git.example.com/octocat/Hello-World
+ * Format: date-time
+ * @description The date and time of when the advisory was last updated, in ISO 8601 format.
*/
- readonly mirror_url: string | null;
+ readonly updated_at: string | null;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/hooks
+ * Format: date-time
+ * @description The date and time of when the advisory was published, in ISO 8601 format.
*/
- readonly hooks_url: string;
+ readonly published_at: string | null;
/**
- * Format: uri
- * @example https://svn.github.com/octocat/Hello-World
+ * Format: date-time
+ * @description The date and time of when the advisory was closed, in ISO 8601 format.
*/
- readonly svn_url: string;
+ readonly closed_at: string | null;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was withdrawn, in ISO 8601 format.
+ */
+ readonly withdrawn_at: string | null;
+ readonly submission: {
+ /** @description Whether a private vulnerability report was accepted by the repository's administrators. */
+ readonly accepted: boolean;
+ } | null;
+ readonly vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null;
+ readonly cvss: {
+ /** @description The CVSS vector. */
+ readonly vector_string: string | null;
+ /** @description The CVSS score. */
+ readonly score: number | null;
+ } | null;
+ readonly cwes: {
+ /** @description The Common Weakness Enumeration (CWE) identifier. */
+ readonly cwe_id: string;
+ /** @description The name of the CWE. */
+ readonly name: string;
+ }[] | null;
+ /** @description A list of only the CWE IDs. */
+ readonly cwe_ids: string[] | null;
+ readonly credits: {
+ /** @description The username of the user credited. */
+ readonly login?: string;
+ readonly type?: components["schemas"]["security-advisory-credit-types"];
+ }[] | null;
+ readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null;
+ /** @description A list of users that collaborate on the advisory. */
+ readonly collaborating_users: components["schemas"]["simple-user"][] | null;
+ /** @description A list of teams that collaborate on the advisory. */
+ readonly collaborating_teams: components["schemas"]["team"][] | null;
+ /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */
+ readonly private_fork: components["schemas"]["simple-repository"] | null;
+ };
+ /**
+ * Team Simple
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ readonly "team-simple": {
+ /**
+ * @description Unique identifier of the team
+ * @example 1
+ */
+ readonly id: number;
+ /** @example MDQ6VGVhbTE= */
+ readonly node_id: string;
/**
* Format: uri
- * @example https://github.com
+ * @description URL for the team
+ * @example https://api.github.com/organizations/1/team/1
*/
- readonly homepage: string | null;
- readonly language: string | null;
- /** @example 9 */
- readonly forks_count: number;
- /** @example 80 */
- readonly stargazers_count: number;
- /** @example 80 */
- readonly watchers_count: number;
+ readonly url: string;
+ /** @example https://api.github.com/organizations/1/team/1/members{/member} */
+ readonly members_url: string;
/**
- * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- * @example 108
+ * @description Name of the team
+ * @example Justice League
*/
- readonly size: number;
+ readonly name: string;
/**
- * @description The default branch of the repository.
- * @example master
+ * @description Description of the team
+ * @example A great team.
*/
- readonly default_branch: string;
- /** @example 0 */
- readonly open_issues_count: number;
+ readonly description: string | null;
/**
- * @description Whether this repository acts as a template that can be used to generate new repositories.
- * @default false
- * @example true
+ * @description Permission that the team will have for its repositories
+ * @example admin
*/
- readonly is_template: boolean;
- readonly topics?: string[];
+ readonly permission: string;
/**
- * @description Whether issues are enabled.
- * @default true
- * @example true
+ * @description The level of privacy this team should have
+ * @example closed
*/
- readonly has_issues: boolean;
+ readonly privacy?: string;
/**
- * @description Whether projects are enabled.
- * @default true
- * @example true
+ * @description The notification setting the team has set
+ * @example notifications_enabled
*/
- readonly has_projects: boolean;
+ readonly notification_setting?: string;
/**
- * @description Whether the wiki is enabled.
- * @default true
- * @example true
+ * Format: uri
+ * @example https://github.com/orgs/rails/teams/core
*/
- readonly has_wiki: boolean;
- readonly has_pages: boolean;
+ readonly html_url: string;
/**
- * @deprecated
- * @description Whether downloads are enabled.
- * @default true
- * @example true
+ * Format: uri
+ * @example https://api.github.com/organizations/1/team/1/repos
*/
- readonly has_downloads: boolean;
+ readonly repositories_url: string;
+ /** @example justice-league */
+ readonly slug: string;
/**
- * @description Whether discussions are enabled.
- * @default false
- * @example true
+ * @description Distinguished Name (DN) that team maps to within LDAP environment
+ * @example uid=example,ou=users,dc=github,dc=com
*/
- readonly has_discussions: boolean;
+ readonly ldap_dn?: string;
+ };
+ readonly "actions-billing-usage": {
+ /** @description The sum of the free and paid GitHub Actions minutes used. */
+ readonly total_minutes_used: number;
+ /** @description The total paid GitHub Actions minutes used. */
+ readonly total_paid_minutes_used: number;
+ /** @description The amount of free GitHub Actions minutes available. */
+ readonly included_minutes: number;
+ readonly minutes_used_breakdown: {
+ /** @description Total minutes used on Ubuntu runner machines. */
+ readonly UBUNTU?: number;
+ /** @description Total minutes used on macOS runner machines. */
+ readonly MACOS?: number;
+ /** @description Total minutes used on Windows runner machines. */
+ readonly WINDOWS?: number;
+ /** @description Total minutes used on Ubuntu 4 core runner machines. */
+ readonly ubuntu_4_core?: number;
+ /** @description Total minutes used on Ubuntu 8 core runner machines. */
+ readonly ubuntu_8_core?: number;
+ /** @description Total minutes used on Ubuntu 16 core runner machines. */
+ readonly ubuntu_16_core?: number;
+ /** @description Total minutes used on Ubuntu 32 core runner machines. */
+ readonly ubuntu_32_core?: number;
+ /** @description Total minutes used on Ubuntu 64 core runner machines. */
+ readonly ubuntu_64_core?: number;
+ /** @description Total minutes used on Windows 4 core runner machines. */
+ readonly windows_4_core?: number;
+ /** @description Total minutes used on Windows 8 core runner machines. */
+ readonly windows_8_core?: number;
+ /** @description Total minutes used on Windows 16 core runner machines. */
+ readonly windows_16_core?: number;
+ /** @description Total minutes used on Windows 32 core runner machines. */
+ readonly windows_32_core?: number;
+ /** @description Total minutes used on Windows 64 core runner machines. */
+ readonly windows_64_core?: number;
+ /** @description Total minutes used on macOS 12 core runner machines. */
+ readonly macos_12_core?: number;
+ /** @description Total minutes used on all runner machines. */
+ readonly total?: number;
+ };
+ };
+ readonly "packages-billing-usage": {
+ /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */
+ readonly total_gigabytes_bandwidth_used: number;
+ /** @description Total paid storage space (GB) for GitHuub Packages. */
+ readonly total_paid_gigabytes_bandwidth_used: number;
+ /** @description Free storage space (GB) for GitHub Packages. */
+ readonly included_gigabytes_bandwidth: number;
+ };
+ readonly "combined-billing-usage": {
+ /** @description Numbers of days left in billing cycle. */
+ readonly days_left_in_billing_cycle: number;
+ /** @description Estimated storage space (GB) used in billing cycle. */
+ readonly estimated_paid_storage_for_month: number;
+ /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */
+ readonly estimated_storage_for_month: number;
+ };
+ /**
+ * Team Organization
+ * @description Team Organization
+ */
+ readonly "team-organization": {
+ /** @example github */
+ readonly login: string;
+ /** @example 1 */
+ readonly id: number;
+ /** @example MDEyOk9yZ2FuaXphdGlvbjE= */
+ readonly node_id: string;
/**
- * @description Whether the repository is archived.
- * @default false
+ * Format: uri
+ * @example https://api.github.com/orgs/github
*/
- readonly archived: boolean;
- /** @description Returns whether or not this repository disabled. */
- readonly disabled: boolean;
+ readonly url: string;
/**
- * @description The repository visibility: public, private, or internal.
- * @default public
+ * Format: uri
+ * @example https://api.github.com/orgs/github/repos
*/
- readonly visibility: string;
+ readonly repos_url: string;
/**
- * Format: date-time
- * @example 2011-01-26T19:06:43Z
+ * Format: uri
+ * @example https://api.github.com/orgs/github/events
*/
- readonly pushed_at: string | null;
+ readonly events_url: string;
+ /** @example https://api.github.com/orgs/github/hooks */
+ readonly hooks_url: string;
+ /** @example https://api.github.com/orgs/github/issues */
+ readonly issues_url: string;
+ /** @example https://api.github.com/orgs/github/members{/member} */
+ readonly members_url: string;
+ /** @example https://api.github.com/orgs/github/public_members{/member} */
+ readonly public_members_url: string;
+ /** @example https://github.com/images/error/octocat_happy.gif */
+ readonly avatar_url: string;
+ /** @example A great organization */
+ readonly description: string | null;
+ /** @example github */
+ readonly name?: string;
+ /** @example GitHub */
+ readonly company?: string;
/**
- * Format: date-time
- * @example 2011-01-26T19:01:12Z
+ * Format: uri
+ * @example https://github.com/blog
*/
- readonly created_at: string | null;
+ readonly blog?: string;
+ /** @example San Francisco */
+ readonly location?: string;
+ /**
+ * Format: email
+ * @example octocat@github.com
+ */
+ readonly email?: string;
+ /** @example github */
+ readonly twitter_username?: string | null;
+ /** @example true */
+ readonly is_verified?: boolean;
+ /** @example true */
+ readonly has_organization_projects: boolean;
+ /** @example true */
+ readonly has_repository_projects: boolean;
+ /** @example 2 */
+ readonly public_repos: number;
+ /** @example 1 */
+ readonly public_gists: number;
+ /** @example 20 */
+ readonly followers: number;
+ /** @example 0 */
+ readonly following: number;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat
+ */
+ readonly html_url: string;
/**
* Format: date-time
- * @example 2011-01-26T19:14:43Z
+ * @example 2008-01-14T04:33:35Z
*/
- readonly updated_at: string | null;
+ readonly created_at: string;
+ /** @example Organization */
+ readonly type: string;
+ /** @example 100 */
+ readonly total_private_repos?: number;
+ /** @example 100 */
+ readonly owned_private_repos?: number;
+ /** @example 81 */
+ readonly private_gists?: number | null;
+ /** @example 10000 */
+ readonly disk_usage?: number | null;
+ /** @example 8 */
+ readonly collaborators?: number | null;
/**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- * @example true
+ * Format: email
+ * @example org@example.com
*/
- readonly allow_rebase_merge: boolean;
- readonly template_repository?: {
- readonly id?: number;
- readonly node_id?: string;
- readonly name?: string;
- readonly full_name?: string;
- readonly owner?: {
- readonly login?: string;
- readonly id?: number;
- readonly node_id?: string;
- readonly avatar_url?: string;
- readonly gravatar_id?: string;
- readonly url?: string;
- readonly html_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly organizations_url?: string;
- readonly repos_url?: string;
- readonly events_url?: string;
- readonly received_events_url?: string;
- readonly type?: string;
- readonly site_admin?: boolean;
- };
- readonly private?: boolean;
- readonly html_url?: string;
- readonly description?: string;
- readonly fork?: boolean;
- readonly url?: string;
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly forks_url?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly git_url?: string;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly notifications_url?: string;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly ssh_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly clone_url?: string;
- readonly mirror_url?: string;
- readonly hooks_url?: string;
- readonly svn_url?: string;
- readonly homepage?: string;
- readonly language?: string;
- readonly forks_count?: number;
- readonly stargazers_count?: number;
- readonly watchers_count?: number;
- readonly size?: number;
- readonly default_branch?: string;
- readonly open_issues_count?: number;
- readonly is_template?: boolean;
- readonly topics?: string[];
- readonly has_issues?: boolean;
- readonly has_projects?: boolean;
- readonly has_wiki?: boolean;
- readonly has_pages?: boolean;
- readonly has_downloads?: boolean;
- readonly archived?: boolean;
- readonly disabled?: boolean;
- readonly visibility?: string;
- readonly pushed_at?: string;
- readonly created_at?: string;
- readonly updated_at?: string;
- readonly permissions?: {
- readonly admin?: boolean;
- readonly maintain?: boolean;
- readonly push?: boolean;
- readonly triage?: boolean;
- readonly pull?: boolean;
- };
- readonly allow_rebase_merge?: boolean;
- readonly temp_clone_token?: string;
- readonly allow_squash_merge?: boolean;
- readonly allow_auto_merge?: boolean;
- readonly delete_branch_on_merge?: boolean;
- readonly allow_update_branch?: boolean;
- readonly use_squash_pr_title_as_default?: boolean;
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- readonly allow_merge_commit?: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
- } | null;
- readonly temp_clone_token?: string;
+ readonly billing_email?: string | null;
+ readonly plan?: {
+ readonly name: string;
+ readonly space: number;
+ readonly private_repos: number;
+ readonly filled_seats?: number;
+ readonly seats?: number;
+ };
+ readonly default_repository_permission?: string | null;
+ /** @example true */
+ readonly members_can_create_repositories?: boolean | null;
+ /** @example true */
+ readonly two_factor_requirement_enabled?: boolean | null;
+ /** @example all */
+ readonly members_allowed_repository_creation_type?: string;
+ /** @example true */
+ readonly members_can_create_public_repositories?: boolean;
+ /** @example true */
+ readonly members_can_create_private_repositories?: boolean;
+ /** @example true */
+ readonly members_can_create_internal_repositories?: boolean;
+ /** @example true */
+ readonly members_can_create_pages?: boolean;
+ /** @example true */
+ readonly members_can_create_public_pages?: boolean;
+ /** @example true */
+ readonly members_can_create_private_pages?: boolean;
+ /** @example false */
+ readonly members_can_fork_private_repositories?: boolean | null;
+ /** @example false */
+ readonly web_commit_signoff_required?: boolean;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: date-time */
+ readonly archived_at: string | null;
+ };
+ /**
+ * Full Team
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ readonly "team-full": {
/**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- * @example true
+ * @description Unique identifier of the team
+ * @example 42
*/
- readonly allow_squash_merge: boolean;
+ readonly id: number;
+ /** @example MDQ6VGVhbTE= */
+ readonly node_id: string;
/**
- * @description Whether to allow Auto-merge to be used on pull requests.
- * @default false
- * @example false
+ * Format: uri
+ * @description URL for the team
+ * @example https://api.github.com/organizations/1/team/1
*/
- readonly allow_auto_merge: boolean;
+ readonly url: string;
/**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- * @example false
+ * Format: uri
+ * @example https://github.com/orgs/rails/teams/core
*/
- readonly delete_branch_on_merge: boolean;
+ readonly html_url: string;
/**
- * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- * @default false
- * @example false
+ * @description Name of the team
+ * @example Developers
*/
- readonly allow_update_branch: boolean;
+ readonly name: string;
+ /** @example justice-league */
+ readonly slug: string;
+ /** @example A great team. */
+ readonly description: string | null;
/**
- * @deprecated
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
+ * @description The level of privacy this team should have
+ * @example closed
+ * @enum {string}
*/
- readonly use_squash_pr_title_as_default: boolean;
+ readonly privacy?: "closed" | "secret";
/**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @description The notification setting the team has set
+ * @example notifications_enabled
* @enum {string}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
/**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
+ * @description Permission that the team will have for its repositories
+ * @example push
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ readonly permission: string;
+ /** @example https://api.github.com/organizations/1/team/1/members{/member} */
+ readonly members_url: string;
/**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
+ * Format: uri
+ * @example https://api.github.com/organizations/1/team/1/repos
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ readonly repositories_url: string;
+ readonly parent?: components["schemas"]["nullable-team-simple"];
+ /** @example 3 */
+ readonly members_count: number;
+ /** @example 10 */
+ readonly repos_count: number;
/**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
+ * Format: date-time
+ * @example 2017-07-14T16:53:42Z
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ readonly created_at: string;
/**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- * @example true
+ * Format: date-time
+ * @example 2017-08-17T12:37:15Z
*/
- readonly allow_merge_commit: boolean;
- /** @description Whether to allow forking this repo */
- readonly allow_forking?: boolean;
+ readonly updated_at: string;
+ readonly organization: components["schemas"]["team-organization"];
/**
- * @description Whether to require contributors to sign off on web-based commits
- * @default false
+ * @description Distinguished Name (DN) that team maps to within LDAP environment
+ * @example uid=example,ou=users,dc=github,dc=com
*/
- readonly web_commit_signoff_required: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
- readonly open_issues: number;
- readonly watchers: number;
- readonly master_branch?: string;
- /** @example "2020-07-09T00:17:42Z" */
- readonly starred_at?: string;
- /** @description Whether anonymous git access is enabled for this repository */
- readonly anonymous_access_enabled?: boolean;
- } | null;
+ readonly ldap_dn?: string;
+ };
/**
- * Code Of Conduct Simple
- * @description Code of Conduct Simple
+ * Team Discussion
+ * @description A team discussion is a persistent record of a free-form conversation within a team.
*/
- readonly "code-of-conduct-simple": {
+ readonly "team-discussion": {
+ readonly author: components["schemas"]["nullable-simple-user"];
+ /**
+ * @description The main text of the discussion.
+ * @example Please suggest improvements to our workflow in comments.
+ */
+ readonly body: string;
+ /** @example Hi! This is an area for us to collaborate as a team
*/
+ readonly body_html: string;
+ /**
+ * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
+ * @example 0307116bbf7ced493b8d8a346c650b71
+ */
+ readonly body_version: string;
+ /** @example 0 */
+ readonly comments_count: number;
/**
* Format: uri
- * @example https://api.github.com/repos/github/docs/community/code_of_conduct
+ * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments
+ */
+ readonly comments_url: string;
+ /**
+ * Format: date-time
+ * @example 2018-01-25T18:56:31Z
+ */
+ readonly created_at: string;
+ /** Format: date-time */
+ readonly last_edited_at: string | null;
+ /**
+ * Format: uri
+ * @example https://github.com/orgs/github/teams/justice-league/discussions/1
+ */
+ readonly html_url: string;
+ /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */
+ readonly node_id: string;
+ /**
+ * @description The unique sequence number of a team discussion.
+ * @example 42
+ */
+ readonly number: number;
+ /**
+ * @description Whether or not this discussion should be pinned for easy retrieval.
+ * @example true
+ */
+ readonly pinned: boolean;
+ /**
+ * @description Whether or not this discussion should be restricted to team members and organization owners.
+ * @example true
+ */
+ readonly private: boolean;
+ /**
+ * Format: uri
+ * @example https://api.github.com/organizations/1/team/2343027
+ */
+ readonly team_url: string;
+ /**
+ * @description The title of the discussion.
+ * @example How can we improve our workflow?
+ */
+ readonly title: string;
+ /**
+ * Format: date-time
+ * @example 2018-01-25T18:56:31Z
+ */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/organizations/1/team/2343027/discussions/1
*/
readonly url: string;
- /** @example citizen_code_of_conduct */
- readonly key: string;
- /** @example Citizen Code of Conduct */
- readonly name: string;
+ readonly reactions?: components["schemas"]["reaction-rollup"];
+ };
+ /**
+ * Team Discussion Comment
+ * @description A reply to a discussion within a team.
+ */
+ readonly "team-discussion-comment": {
+ readonly author: components["schemas"]["nullable-simple-user"];
+ /**
+ * @description The main text of the comment.
+ * @example I agree with this suggestion.
+ */
+ readonly body: string;
+ /** @example Do you like apples?
*/
+ readonly body_html: string;
+ /**
+ * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
+ * @example 0307116bbf7ced493b8d8a346c650b71
+ */
+ readonly body_version: string;
+ /**
+ * Format: date-time
+ * @example 2018-01-15T23:53:58Z
+ */
+ readonly created_at: string;
+ /** Format: date-time */
+ readonly last_edited_at: string | null;
/**
* Format: uri
- * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
+ * @example https://api.github.com/organizations/1/team/2403582/discussions/1
*/
- readonly html_url: string | null;
+ readonly discussion_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
+ */
+ readonly html_url: string;
+ /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */
+ readonly node_id: string;
+ /**
+ * @description The unique sequence number of a team discussion comment.
+ * @example 42
+ */
+ readonly number: number;
+ /**
+ * Format: date-time
+ * @example 2018-01-15T23:53:58Z
+ */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
+ */
+ readonly url: string;
+ readonly reactions?: components["schemas"]["reaction-rollup"];
};
/**
- * Full Repository
- * @description Full Repository
+ * Reaction
+ * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively.
*/
- readonly "full-repository": {
- /** @example 1296269 */
+ readonly reaction: {
+ /** @example 1 */
+ readonly id: number;
+ /** @example MDg6UmVhY3Rpb24x */
+ readonly node_id: string;
+ readonly user: components["schemas"]["nullable-simple-user"];
+ /**
+ * @description The reaction to use
+ * @example heart
+ * @enum {string}
+ */
+ readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
+ /**
+ * Format: date-time
+ * @example 2016-05-20T20:09:31Z
+ */
+ readonly created_at: string;
+ };
+ /**
+ * Team Membership
+ * @description Team Membership
+ */
+ readonly "team-membership": {
+ /** Format: uri */
+ readonly url: string;
+ /**
+ * @description The role of the user in the team.
+ * @default member
+ * @example member
+ * @enum {string}
+ */
+ readonly role: "member" | "maintainer";
+ /**
+ * @description The state of the user's membership in the team.
+ * @enum {string}
+ */
+ readonly state: "active" | "pending";
+ };
+ /**
+ * Team Project
+ * @description A team's access to a project.
+ */
+ readonly "team-project": {
+ readonly owner_url: string;
+ readonly url: string;
+ readonly html_url: string;
+ readonly columns_url: string;
+ readonly id: number;
+ readonly node_id: string;
+ readonly name: string;
+ readonly body: string | null;
+ readonly number: number;
+ readonly state: string;
+ readonly creator: components["schemas"]["simple-user"];
+ readonly created_at: string;
+ readonly updated_at: string;
+ /** @description The organization permission for this project. Only present when owner is an organization. */
+ readonly organization_permission?: string;
+ /** @description Whether the project is private or not. Only present when owner is an organization. */
+ readonly private?: boolean;
+ readonly permissions: {
+ readonly read: boolean;
+ readonly write: boolean;
+ readonly admin: boolean;
+ };
+ };
+ /**
+ * Team Repository
+ * @description A team's access to a repository.
+ */
+ readonly "team-repository": {
+ /**
+ * @description Unique identifier of the repository
+ * @example 42
+ */
readonly id: number;
/** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
readonly node_id: string;
- /** @example Hello-World */
+ /**
+ * @description The name of the repository.
+ * @example Team Environment
+ */
readonly name: string;
/** @example octocat/Hello-World */
readonly full_name: string;
- readonly owner: components["schemas"]["simple-user"];
+ readonly license: components["schemas"]["nullable-license-simple"];
+ readonly forks: number;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly pull: boolean;
+ readonly triage?: boolean;
+ readonly push: boolean;
+ readonly maintain?: boolean;
+ };
+ /** @example admin */
+ readonly role_name?: string;
+ readonly owner: components["schemas"]["nullable-simple-user"];
+ /**
+ * @description Whether the repository is private or public.
+ * @default false
+ */
readonly private: boolean;
/**
* Format: uri
@@ -23698,142 +24326,252 @@ export type components = {
readonly stargazers_count: number;
/** @example 80 */
readonly watchers_count: number;
+ /** @example 108 */
+ readonly size: number;
/**
- * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- * @example 108
+ * @description The default branch of the repository.
+ * @example master
*/
- readonly size: number;
- /** @example master */
readonly default_branch: string;
/** @example 0 */
readonly open_issues_count: number;
- /** @example true */
- readonly is_template?: boolean;
- /** @example [
- * "octocat",
- * "atom",
- * "electron",
- * "API"
- * ] */
+ /**
+ * @description Whether this repository acts as a template that can be used to generate new repositories.
+ * @default false
+ * @example true
+ */
+ readonly is_template: boolean;
readonly topics?: string[];
- /** @example true */
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ * @example true
+ */
readonly has_issues: boolean;
- /** @example true */
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ * @example true
+ */
readonly has_projects: boolean;
- /** @example true */
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ * @example true
+ */
readonly has_wiki: boolean;
readonly has_pages: boolean;
- /** @example true */
- readonly has_downloads?: boolean;
- /** @example true */
- readonly has_discussions: boolean;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ * @example true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
readonly archived: boolean;
/** @description Returns whether or not this repository disabled. */
readonly disabled: boolean;
/**
* @description The repository visibility: public, private, or internal.
- * @example public
+ * @default public
*/
- readonly visibility?: string;
+ readonly visibility: string;
/**
* Format: date-time
* @example 2011-01-26T19:06:43Z
*/
- readonly pushed_at: string;
+ readonly pushed_at: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- readonly created_at: string;
+ readonly created_at: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:14:43Z
*/
- readonly updated_at: string;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- readonly pull: boolean;
- };
- /** @example true */
- readonly allow_rebase_merge?: boolean;
- readonly template_repository?: components["schemas"]["nullable-repository"];
- readonly temp_clone_token?: string | null;
- /** @example true */
- readonly allow_squash_merge?: boolean;
- /** @example false */
- readonly allow_auto_merge?: boolean;
- /** @example false */
- readonly delete_branch_on_merge?: boolean;
- /** @example true */
- readonly allow_merge_commit?: boolean;
- /** @example true */
- readonly allow_update_branch?: boolean;
- /** @example false */
- readonly use_squash_pr_title_as_default?: boolean;
+ readonly updated_at: string | null;
/**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @example PR_TITLE
- * @enum {string}
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ * @example true
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly allow_rebase_merge: boolean;
+ readonly temp_clone_token?: string;
/**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @example PR_BODY
- * @enum {string}
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ * @example true
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ readonly allow_squash_merge: boolean;
/**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @example PR_TITLE
- * @enum {string}
+ * @description Whether to allow Auto-merge to be used on pull requests.
+ * @default false
+ * @example false
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ readonly allow_auto_merge: boolean;
/**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @example PR_BODY
- * @enum {string}
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ * @example false
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /** @example true */
- readonly allow_forking?: boolean;
- /** @example false */
- readonly web_commit_signoff_required?: boolean;
- /** @example 42 */
- readonly subscribers_count: number;
- /** @example 0 */
- readonly network_count: number;
- readonly license: components["schemas"]["nullable-license-simple"];
- readonly organization?: components["schemas"]["nullable-simple-user"];
- readonly parent?: components["schemas"]["repository"];
- readonly source?: components["schemas"]["repository"];
- readonly forks: number;
- readonly master_branch?: string;
+ readonly delete_branch_on_merge: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ * @example true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow forking this repo
+ * @default false
+ * @example false
+ */
+ readonly allow_forking: boolean;
+ /**
+ * @description Whether to require contributors to sign off on web-based commits
+ * @default false
+ * @example false
+ */
+ readonly web_commit_signoff_required: boolean;
+ readonly subscribers_count?: number;
+ readonly network_count?: number;
readonly open_issues: number;
readonly watchers: number;
+ readonly master_branch?: string;
+ };
+ /**
+ * Project Card
+ * @description Project cards represent a scope of work.
+ */
+ readonly "project-card": {
/**
- * @description Whether anonymous git access is allowed.
- * @default true
+ * Format: uri
+ * @example https://api.github.com/projects/columns/cards/1478
*/
- readonly anonymous_access_enabled: boolean;
- readonly code_of_conduct?: components["schemas"]["code-of-conduct-simple"];
- readonly security_and_analysis?: components["schemas"]["security-and-analysis"];
+ readonly url: string;
+ /**
+ * @description The project card's ID
+ * @example 42
+ */
+ readonly id: number;
+ /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */
+ readonly node_id: string;
+ /** @example Add payload for delete Project column */
+ readonly note: string | null;
+ readonly creator: components["schemas"]["nullable-simple-user"];
+ /**
+ * Format: date-time
+ * @example 2016-09-05T14:21:06Z
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @example 2016-09-05T14:20:22Z
+ */
+ readonly updated_at: string;
+ /**
+ * @description Whether or not the card is archived
+ * @example false
+ */
+ readonly archived?: boolean;
+ readonly column_name?: string;
+ readonly project_id?: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/projects/columns/367
+ */
+ readonly column_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/api-playground/projects-test/issues/3
+ */
+ readonly content_url?: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/projects/120
+ */
+ readonly project_url: string;
+ };
+ /**
+ * Project Column
+ * @description Project columns contain cards of work.
+ */
+ readonly "project-column": {
+ /**
+ * Format: uri
+ * @example https://api.github.com/projects/columns/367
+ */
+ readonly url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/projects/120
+ */
+ readonly project_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/projects/columns/367/cards
+ */
+ readonly cards_url: string;
+ /**
+ * @description The unique identifier of the project column
+ * @example 42
+ */
+ readonly id: number;
+ /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */
+ readonly node_id: string;
+ /**
+ * @description Name of the project column
+ * @example Remaining tasks
+ */
+ readonly name: string;
+ /**
+ * Format: date-time
+ * @example 2016-09-05T14:18:44Z
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @example 2016-09-05T14:22:28Z
+ */
+ readonly updated_at: string;
+ };
+ /**
+ * Project Collaborator Permission
+ * @description Project Collaborator Permission
+ */
+ readonly "project-collaborator-permission": {
+ readonly permission: string;
+ readonly user: components["schemas"]["nullable-simple-user"];
+ };
+ /** Rate Limit */
+ readonly "rate-limit": {
+ readonly limit: number;
+ readonly remaining: number;
+ readonly reset: number;
+ readonly used: number;
+ };
+ /**
+ * Rate Limit Overview
+ * @description Rate Limit Overview
+ */
+ readonly "rate-limit-overview": {
+ readonly resources: {
+ readonly core: components["schemas"]["rate-limit"];
+ readonly graphql?: components["schemas"]["rate-limit"];
+ readonly search: components["schemas"]["rate-limit"];
+ readonly code_search?: components["schemas"]["rate-limit"];
+ readonly source_import?: components["schemas"]["rate-limit"];
+ readonly integration_manifest?: components["schemas"]["rate-limit"];
+ readonly code_scanning_upload?: components["schemas"]["rate-limit"];
+ readonly actions_runner_registration?: components["schemas"]["rate-limit"];
+ readonly scim?: components["schemas"]["rate-limit"];
+ readonly dependency_snapshots?: components["schemas"]["rate-limit"];
+ };
+ readonly rate: components["schemas"]["rate-limit"];
};
/**
* Artifact
@@ -23951,7 +24689,7 @@ export type components = {
* @example queued
* @enum {string}
*/
- readonly status: "queued" | "in_progress" | "completed" | "waiting";
+ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
/**
* @description The outcome of the job.
* @example success
@@ -24118,7 +24856,7 @@ export type components = {
* @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the
* repository.
*
- * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization.
+ * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.
* @enum {string}
*/
readonly access_level: "none" | "user" | "organization";
@@ -25284,11 +26022,11 @@ export type components = {
/** @example https://example.com */
readonly details_url: string | null;
/**
- * @description The phase of the lifecycle that the check is currently in.
+ * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.
* @example queued
* @enum {string}
*/
- readonly status: "queued" | "in_progress" | "completed";
+ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
/**
* @example neutral
* @enum {string|null}
@@ -25419,10 +26157,11 @@ export type components = {
*/
readonly head_sha: string;
/**
+ * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.
* @example completed
* @enum {string|null}
*/
- readonly status: "queued" | "in_progress" | "completed";
+ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
/**
* @example neutral
* @enum {string|null}
@@ -25460,21 +26199,6 @@ export type components = {
};
readonly repository: components["schemas"]["minimal-repository"];
};
- readonly "code-scanning-alert-rule-summary": {
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id?: string | null;
- /** @description The name of the rule used to detect the alert. */
- readonly name?: string;
- /** @description A set of tags applicable for the rule. */
- readonly tags?: string[] | null;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity?: "none" | "note" | "warning" | "error";
- /** @description A short description of the rule used to detect the alert. */
- readonly description?: string;
- };
readonly "code-scanning-alert-items": {
readonly number: components["schemas"]["alert-number"];
readonly created_at: components["schemas"]["alert-created-at"];
@@ -25492,6 +26216,32 @@ export type components = {
readonly tool: components["schemas"]["code-scanning-analysis-tool"];
readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
};
+ readonly "code-scanning-alert-rule": {
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id?: string | null;
+ /** @description The name of the rule used to detect the alert. */
+ readonly name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity?: "none" | "note" | "warning" | "error";
+ /**
+ * @description The security severity of the alert.
+ * @enum {string|null}
+ */
+ readonly security_severity_level?: "low" | "medium" | "high" | "critical";
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description?: string;
+ /** @description description of the rule used to detect the alert. */
+ readonly full_description?: string;
+ /** @description A set of tags applicable for the rule. */
+ readonly tags?: string[] | null;
+ /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */
+ readonly help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ readonly help_uri?: string | null;
+ };
readonly "code-scanning-alert": {
readonly number: components["schemas"]["alert-number"];
readonly created_at: components["schemas"]["alert-created-at"];
@@ -25659,7 +26409,7 @@ export type components = {
};
/**
* @description The full Git reference, formatted as `refs/heads/`,
- * `refs/pull//merge`, or `refs/pull//head`.
+ * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`.
* @example refs/heads/main
*/
readonly "code-scanning-ref-full": string;
@@ -27447,24 +28197,7 @@ export type components = {
* ]
*/
readonly events: string[];
- readonly config: {
- /** @example "foo@bar.com" */
- readonly email?: string;
- /** @example "foo" */
- readonly password?: string;
- /** @example "roomer" */
- readonly room?: string;
- /** @example "foo" */
- readonly subdomain?: string;
- readonly url?: components["schemas"]["webhook-config-url"];
- readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
- readonly content_type?: components["schemas"]["webhook-config-content-type"];
- /** @example "sha256" */
- readonly digest?: string;
- readonly secret?: components["schemas"]["webhook-config-secret"];
- /** @example "abc" */
- readonly token?: string;
- };
+ readonly config: components["schemas"]["webhook-config"];
/**
* Format: date-time
* @example 2011-09-06T20:39:23Z
@@ -28772,10 +29505,12 @@ export type components = {
* @description The GitHub Pages deployment status.
*/
readonly "page-deployment": {
+ /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */
+ readonly id: number | string;
/**
* Format: uri
* @description The URI to monitor GitHub Pages deployment status.
- * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status
+ * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251
*/
readonly status_url: string;
/**
@@ -28791,6 +29526,14 @@ export type components = {
*/
readonly preview_url?: string;
};
+ /** GitHub Pages deployment status */
+ readonly "pages-deployment-status": {
+ /**
+ * @description The current status of the deployment.
+ * @enum {string}
+ */
+ readonly status?: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed";
+ };
/**
* Pages Health Check Status
* @description Pages Health Check Status
@@ -29728,6 +30471,42 @@ export type components = {
/** @description The API URL to get the associated commit resource */
readonly commit_url: string;
};
+ /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */
+ readonly "secret-scanning-location-wiki-commit": {
+ /**
+ * @description The file path of the wiki page
+ * @example /example/Home.md
+ */
+ readonly path: string;
+ /** @description Line number at which the secret starts in the file */
+ readonly start_line: number;
+ /** @description Line number at which the secret ends in the file */
+ readonly end_line: number;
+ /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */
+ readonly start_column: number;
+ /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */
+ readonly end_column: number;
+ /**
+ * @description SHA-1 hash ID of the associated blob
+ * @example af5626b4a114abcb82d63db7c8082c3c4756e51b
+ */
+ readonly blob_sha: string;
+ /**
+ * @description The GitHub URL to get the associated wiki page
+ * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5
+ */
+ readonly page_url: string;
+ /**
+ * @description SHA-1 hash ID of the associated commit
+ * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5
+ */
+ readonly commit_sha: string;
+ /**
+ * @description The GitHub URL to get the associated wiki commit
+ * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5
+ */
+ readonly commit_url: string;
+ };
/** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */
readonly "secret-scanning-location-issue-title": {
/**
@@ -29755,14 +30534,86 @@ export type components = {
*/
readonly issue_comment_url: string;
};
+ /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */
+ readonly "secret-scanning-location-discussion-title": {
+ /**
+ * Format: uri
+ * @description The URL to the discussion where the secret was detected.
+ * @example https://github.com/community/community/discussions/39082
+ */
+ readonly discussion_title_url: string;
+ };
+ /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */
+ readonly "secret-scanning-location-discussion-body": {
+ /**
+ * Format: uri
+ * @description The URL to the discussion where the secret was detected.
+ * @example https://github.com/community/community/discussions/39082#discussion-4566270
+ */
+ readonly discussion_body_url: string;
+ };
+ /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */
+ readonly "secret-scanning-location-discussion-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the discussion comment where the secret was detected.
+ * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232
+ */
+ readonly discussion_comment_url: string;
+ };
+ /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */
+ readonly "secret-scanning-location-pull-request-title": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pull/2846
+ */
+ readonly pull_request_title_url: string;
+ };
+ /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */
+ readonly "secret-scanning-location-pull-request-body": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pull/2846
+ */
+ readonly pull_request_body_url: string;
+ };
+ /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */
+ readonly "secret-scanning-location-pull-request-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request comment where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
+ */
+ readonly pull_request_comment_url: string;
+ };
+ /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */
+ readonly "secret-scanning-location-pull-request-review": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request review where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
+ */
+ readonly pull_request_review_url: string;
+ };
+ /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */
+ readonly "secret-scanning-location-pull-request-review-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request review comment where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12
+ */
+ readonly pull_request_review_comment_url: string;
+ };
readonly "secret-scanning-location": {
/**
- * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found.
+ * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.
* @example commit
* @enum {string}
*/
- readonly type: "commit" | "issue_title" | "issue_body" | "issue_comment";
- readonly 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"];
+ readonly type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment";
+ readonly details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"];
};
readonly "repository-advisory-create": {
/** @description A short summary of the advisory. */
@@ -29801,6 +30652,11 @@ export type components = {
readonly severity?: "critical" | "high" | "medium" | "low";
/** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */
readonly cvss_vector_string?: string | null;
+ /**
+ * @description Whether to create a temporary private fork of the repository to collaborate on a fix.
+ * @default false
+ */
+ readonly start_private_fork: boolean;
};
readonly "private-vulnerability-report-create": {
/** @description A short summary of the advisory. */
@@ -29831,6 +30687,11 @@ export type components = {
readonly severity?: "critical" | "high" | "medium" | "low";
/** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */
readonly cvss_vector_string?: string | null;
+ /**
+ * @description Whether to create a temporary private fork of the repository to collaborate on a fix.
+ * @default false
+ */
+ readonly start_private_fork: boolean;
};
readonly "repository-advisory-update": {
/** @description A short summary of the advisory. */
@@ -31311,7 +32172,7 @@ export type components = {
/** @example 80 */
readonly watchers_count: number;
/**
- * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
* @example 108
*/
readonly size: number;
@@ -31698,6 +32559,50 @@ export type components = {
/** @example "2020-07-09T00:17:55Z" */
readonly starred_at?: string;
};
+ /**
+ * branch protection rule
+ * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.
+ */
+ readonly webhooks_rule: {
+ readonly admin_enforced: boolean;
+ /** @enum {string} */
+ readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone";
+ /** @enum {string} */
+ readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone";
+ readonly authorized_actor_names: string[];
+ readonly authorized_actors_only: boolean;
+ readonly authorized_dismissal_actors_only: boolean;
+ readonly create_protected?: boolean;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly dismiss_stale_reviews_on_push: boolean;
+ readonly id: number;
+ readonly ignore_approvals_from_contributors: boolean;
+ /** @enum {string} */
+ readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone";
+ /** @enum {string} */
+ readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone";
+ readonly name: string;
+ /** @enum {string} */
+ readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone";
+ readonly repository_id: number;
+ readonly require_code_owner_review: boolean;
+ /** @description Whether the most recent push must be approved by someone other than the person who pushed it */
+ readonly require_last_push_approval?: boolean;
+ readonly required_approving_review_count: number;
+ /** @enum {string} */
+ readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone";
+ /** @enum {string} */
+ readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone";
+ readonly required_status_checks: string[];
+ /** @enum {string} */
+ readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone";
+ /** @enum {string} */
+ readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone";
+ readonly strict_required_status_checks_policy: boolean;
+ /** Format: date-time */
+ readonly updated_at: string;
+ };
/** @description A suite of checks performed on the code of a given code change */
readonly "simple-check-suite": {
/** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */
@@ -31799,15 +32704,68 @@ export type components = {
/** @example https://api.github.com/repos/github/hello-world/check-runs/4 */
readonly url: string;
};
- /**
- * Discussion
- * @description A Discussion in a repository.
- */
- readonly discussion: {
- readonly active_lock_reason: string | null;
- readonly answer_chosen_at: string | null;
+ /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
+ readonly webhooks_code_scanning_commit_oid: string;
+ /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
+ readonly webhooks_code_scanning_ref: string;
+ /** @description The pusher type for the event. Can be either `user` or a deploy key. */
+ readonly webhooks_deploy_pusher_type: string;
+ /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */
+ readonly webhooks_ref_0: string;
+ /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */
+ readonly webhooks_deploy_key: {
+ readonly added_by?: string | null;
+ readonly created_at: string;
+ readonly id: number;
+ readonly key: string;
+ readonly last_used?: string | null;
+ readonly read_only: boolean;
+ readonly title: string;
+ /** Format: uri */
+ readonly url: string;
+ readonly verified: boolean;
+ };
+ /** Workflow */
+ readonly webhooks_workflow: {
+ /** Format: uri */
+ readonly badge_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string;
+ readonly node_id: string;
+ readonly path: string;
+ readonly state: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ readonly webhooks_approver: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
+ readonly webhooks_reviewers: {
/** User */
- readonly answer_chosen_by: {
+ readonly reviewer?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -31843,7 +32801,57 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- readonly answer_html_url: string | null;
+ /** @enum {string} */
+ readonly type?: "User";
+ }[];
+ readonly webhooks_workflow_job_run: {
+ readonly conclusion: unknown;
+ readonly created_at: string;
+ readonly environment: string;
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: unknown;
+ readonly status: string;
+ readonly updated_at: string;
+ };
+ /** User */
+ readonly webhooks_user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly webhooks_answer: {
/**
* AuthorAssociation
* @description How the author is associated with the repository.
@@ -31851,27 +32859,14 @@ export type components = {
*/
readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
readonly body: string;
- readonly category: {
- /** Format: date-time */
- readonly created_at: string;
- readonly description: string;
- readonly emoji: string;
- readonly id: number;
- readonly is_answerable: boolean;
- readonly name: string;
- readonly node_id?: string;
- readonly repository_id: number;
- readonly slug: string;
- readonly updated_at: string;
- };
- readonly comments: number;
+ readonly child_comment_count: number;
/** Format: date-time */
readonly created_at: string;
+ readonly discussion_id: number;
readonly html_url: string;
readonly id: number;
- readonly locked: boolean;
readonly node_id: string;
- readonly number: number;
+ readonly parent_id: unknown;
/** Reactions */
readonly reactions?: {
readonly "+1": number;
@@ -31887,21 +32882,6 @@ export type components = {
readonly url: string;
};
readonly repository_url: string;
- /**
- * @description The current state of the discussion.
- * `converting` means that the discussion is being converted from an issue.
- * `transferring` means that the discussion is being transferred from another repository.
- * @enum {string}
- */
- readonly state: "open" | "closed" | "locked" | "converting" | "transferring";
- /**
- * @description The reason for the current state
- * @example resolved
- * @enum {string|null}
- */
- readonly state_reason: "resolved" | "outdated" | "duplicate" | "reopened";
- readonly timeline_url?: string;
- readonly title: string;
/** Format: date-time */
readonly updated_at: string;
/** User */
@@ -31943,11797 +32923,2518 @@ export type components = {
} | null;
};
/**
- * Merge Group
- * @description A group of pull requests that the merge queue has grouped together to be merged.
- *
- */
- readonly "merge-group": {
- /** @description The SHA of the merge group. */
- readonly head_sha: string;
- /** @description The full ref of the merge group. */
- readonly head_ref: string;
- /** @description The SHA of the merge group's parent commit. */
- readonly base_sha: string;
- /** @description The full ref of the branch the merge group will be merged into. */
- readonly base_ref: string;
- readonly head_commit: components["schemas"]["simple-commit"];
- };
- /**
- * Repository
- * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
- * when the event occurs from activity in a repository.
+ * Discussion
+ * @description A Discussion in a repository.
*/
- readonly "nullable-repository-webhooks": {
+ readonly discussion: {
+ readonly active_lock_reason: string | null;
+ readonly answer_chosen_at: string | null;
+ /** User */
+ readonly answer_chosen_by: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly answer_html_url: string | null;
/**
- * @description Unique identifier of the repository
- * @example 42
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
*/
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ readonly body: string;
+ readonly category: {
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly description: string;
+ readonly emoji: string;
+ readonly id: number;
+ readonly is_answerable: boolean;
+ readonly name: string;
+ readonly node_id?: string;
+ readonly repository_id: number;
+ readonly slug: string;
+ readonly updated_at: string;
+ };
+ readonly comments: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly html_url: string;
readonly id: number;
- /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ readonly locked: boolean;
readonly node_id: string;
+ readonly number: number;
+ /** Reactions */
+ readonly reactions?: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly repository_url: string;
/**
- * @description The name of the repository.
- * @example Team Environment
+ * @description The current state of the discussion.
+ * `converting` means that the discussion is being converted from an issue.
+ * `transferring` means that the discussion is being transferred from another repository.
+ * @enum {string}
*/
- readonly name: string;
- /** @example octocat/Hello-World */
- readonly full_name: string;
- readonly license: components["schemas"]["nullable-license-simple"];
- readonly organization?: components["schemas"]["nullable-simple-user"];
- readonly forks: number;
- readonly permissions?: {
- readonly admin: boolean;
- readonly pull: boolean;
- readonly triage?: boolean;
- readonly push: boolean;
- readonly maintain?: boolean;
- };
- readonly owner: components["schemas"]["simple-user"];
+ readonly state: "open" | "closed" | "locked" | "converting" | "transferring";
/**
- * @description Whether the repository is private or public.
- * @default false
+ * @description The reason for the current state
+ * @example resolved
+ * @enum {string|null}
*/
- readonly private: boolean;
+ readonly state_reason: "resolved" | "outdated" | "duplicate" | "reopened";
+ readonly timeline_url?: string;
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ readonly webhooks_comment: {
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
*/
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ readonly body: string;
+ readonly child_comment_count: number;
+ readonly created_at: string;
+ readonly discussion_id: number;
readonly html_url: string;
- /** @example This your first repo! */
+ readonly id: number;
+ readonly node_id: string;
+ readonly parent_id: number | null;
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly repository_url: string;
+ readonly updated_at: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ /** Label */
+ readonly webhooks_label: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
readonly description: string | null;
- readonly fork: boolean;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World
+ * @description URL for the label
*/
readonly url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
- readonly archive_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
- readonly assignees_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
- readonly blobs_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
- readonly branches_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
- readonly collaborators_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
- readonly comments_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
- readonly commits_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
- readonly compare_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
- readonly contents_url: string;
+ };
+ /** @description An array of repository objects that the installation can access. */
+ readonly webhooks_repositories: {
+ readonly full_name: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ }[];
+ /** @description An array of repository objects, which were added to the installation. */
+ readonly webhooks_repositories_added: {
+ readonly full_name: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ }[];
+ /**
+ * @description Describe whether all repositories have been selected or there's a selection involved
+ * @enum {string}
+ */
+ readonly webhooks_repository_selection: "all" | "selected";
+ /**
+ * issue comment
+ * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
+ */
+ readonly webhooks_issue_comment: {
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/contributors
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
*/
- readonly contributors_url: string;
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue comment */
+ readonly body: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** Format: uri */
+ readonly html_url: string;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/deployments
+ * Format: int64
+ * @description Unique identifier of the issue comment
*/
- readonly deployments_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly issue_url: string;
+ readonly node_id: string;
+ readonly performed_via_github_app: components["schemas"]["integration"];
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Format: date-time */
+ readonly updated_at: string;
/**
* Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/downloads
+ * @description URL for the issue comment
*/
- readonly downloads_url: string;
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ /** @description The changes to the comment. */
+ readonly webhooks_changes: {
+ readonly body?: {
+ /** @description The previous version of the body. */
+ readonly from: string;
+ };
+ };
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ readonly webhooks_issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ /** User */
+ readonly assignee?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/events
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
*/
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
readonly events_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/forks
- */
- readonly forks_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
- readonly git_commits_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
- readonly git_refs_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
- readonly git_tags_url: string;
- /** @example git:github.com/octocat/Hello-World.git */
- readonly git_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
- readonly issue_comment_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
- readonly issue_events_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
- readonly issues_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
- readonly keys_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
readonly labels_url: string;
+ readonly locked?: boolean;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/languages
- */
- readonly languages_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/merges
+ * Milestone
+ * @description A collection of related issues and pull requests.
*/
- readonly merges_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
- readonly milestones_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
- readonly notifications_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
- readonly pulls_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
- readonly releases_url: string;
- /** @example git@github.com:octocat/Hello-World.git */
- readonly ssh_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/stargazers
- */
- readonly stargazers_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
- readonly statuses_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/subscribers
- */
- readonly subscribers_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/subscription
- */
- readonly subscription_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/tags
- */
- readonly tags_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/teams
- */
- readonly teams_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
- readonly trees_url: string;
- /** @example https://github.com/octocat/Hello-World.git */
- readonly clone_url: string;
- /**
- * Format: uri
- * @example git:git.example.com/octocat/Hello-World
- */
- readonly mirror_url: string | null;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/hooks
- */
- readonly hooks_url: string;
- /**
- * Format: uri
- * @example https://svn.github.com/octocat/Hello-World
- */
- readonly svn_url: string;
- /**
- * Format: uri
- * @example https://github.com
- */
- readonly homepage: string | null;
- readonly language: string | null;
- /** @example 9 */
- readonly forks_count: number;
- /** @example 80 */
- readonly stargazers_count: number;
- /** @example 80 */
- readonly watchers_count: number;
- /**
- * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- * @example 108
- */
- readonly size: number;
- /**
- * @description The default branch of the repository.
- * @example master
- */
- readonly default_branch: string;
- /** @example 0 */
- readonly open_issues_count: number;
- /**
- * @description Whether this repository acts as a template that can be used to generate new repositories.
- * @default false
- * @example true
- */
- readonly is_template: boolean;
- readonly topics?: string[];
- /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
- };
- /**
- * @description Whether issues are enabled.
- * @default true
- * @example true
- */
- readonly has_issues: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- * @example true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- * @example true
- */
- readonly has_wiki: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether downloads are enabled.
- * @default true
- * @example true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- * @example true
- */
- readonly has_discussions: boolean;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
- /** @description Returns whether or not this repository disabled. */
- readonly disabled: boolean;
- /**
- * @description The repository visibility: public, private, or internal.
- * @default public
- */
- readonly visibility: string;
- /**
- * Format: date-time
- * @example 2011-01-26T19:06:43Z
- */
- readonly pushed_at: string | null;
- /**
- * Format: date-time
- * @example 2011-01-26T19:01:12Z
- */
- readonly created_at: string | null;
- /**
- * Format: date-time
- * @example 2011-01-26T19:14:43Z
- */
- readonly updated_at: string | null;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- * @example true
- */
- readonly allow_rebase_merge: boolean;
- readonly template_repository?: {
- readonly id?: number;
- readonly node_id?: string;
- readonly name?: string;
- readonly full_name?: string;
- readonly owner?: {
- readonly login?: string;
- readonly id?: number;
- readonly node_id?: string;
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
readonly avatar_url?: string;
- readonly gravatar_id?: string;
- readonly url?: string;
- readonly html_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
readonly followers_url?: string;
+ /** Format: uri-template */
readonly following_url?: string;
+ /** Format: uri-template */
readonly gists_url?: string;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
readonly organizations_url?: string;
- readonly repos_url?: string;
- readonly events_url?: string;
+ /** Format: uri */
readonly received_events_url?: string;
- readonly type?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
readonly site_admin?: boolean;
- };
- readonly private?: boolean;
- readonly html_url?: string;
- readonly description?: string;
- readonly fork?: boolean;
- readonly url?: string;
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly forks_url?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly git_url?: string;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly notifications_url?: string;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly ssh_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly clone_url?: string;
- readonly mirror_url?: string;
- readonly hooks_url?: string;
- readonly svn_url?: string;
- readonly homepage?: string;
- readonly language?: string;
- readonly forks_count?: number;
- readonly stargazers_count?: number;
- readonly watchers_count?: number;
- readonly size?: number;
- readonly default_branch?: string;
- readonly open_issues_count?: number;
- readonly is_template?: boolean;
- readonly topics?: string[];
- readonly has_issues?: boolean;
- readonly has_projects?: boolean;
- readonly has_wiki?: boolean;
- readonly has_pages?: boolean;
- readonly has_downloads?: boolean;
- readonly archived?: boolean;
- readonly disabled?: boolean;
- readonly visibility?: string;
- readonly pushed_at?: string;
- readonly created_at?: string;
- readonly updated_at?: string;
- readonly permissions?: {
- readonly admin?: boolean;
- readonly maintain?: boolean;
- readonly push?: boolean;
- readonly triage?: boolean;
- readonly pull?: boolean;
- };
- readonly allow_rebase_merge?: boolean;
- readonly temp_clone_token?: string;
- readonly allow_squash_merge?: boolean;
- readonly allow_auto_merge?: boolean;
- readonly delete_branch_on_merge?: boolean;
- readonly allow_update_branch?: boolean;
- readonly use_squash_pr_title_as_default?: boolean;
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
/**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
+ * @description The state of the milestone.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- readonly allow_merge_commit?: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
} | null;
- readonly temp_clone_token?: string;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- * @example true
- */
- readonly allow_squash_merge: boolean;
- /**
- * @description Whether to allow Auto-merge to be used on pull requests.
- * @default false
- * @example false
- */
- readonly allow_auto_merge: boolean;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- * @example false
- */
- readonly delete_branch_on_merge: boolean;
- /**
- * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- * @default false
- * @example false
- */
- readonly allow_update_branch: boolean;
- /**
- * @deprecated
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
+ readonly node_id: string;
+ readonly number: number;
/**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Format: uri */
+ readonly repository_url: string;
/**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
+ * @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
/**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
+ * Format: uri
+ * @description URL for the issue
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- * @example true
- */
- readonly allow_merge_commit: boolean;
- /** @description Whether to allow forking this repo */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to require contributors to sign off on web-based commits
- * @default false
- */
- readonly web_commit_signoff_required: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
- readonly open_issues: number;
- readonly watchers: number;
- readonly master_branch?: string;
- /** @example "2020-07-09T00:17:42Z" */
- readonly starred_at?: string;
- /** @description Whether anonymous git access is enabled for this repository */
- readonly anonymous_access_enabled?: boolean;
- } | null;
- /**
- * Personal Access Token Request
- * @description Details of a Personal Access Token Request.
- */
- readonly "personal-access-token-request": {
- /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */
- readonly id: number;
- readonly owner: components["schemas"]["simple-user"];
- /** @description New requested permissions, categorized by type of permission. */
- readonly permissions_added: {
- readonly organization?: {
- readonly [key: string]: string | undefined;
- };
- readonly repository?: {
- readonly [key: string]: string | undefined;
- };
- readonly other?: {
- readonly [key: string]: string | undefined;
- };
- };
- /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */
- readonly permissions_upgraded: {
- readonly organization?: {
- readonly [key: string]: string | undefined;
- };
- readonly repository?: {
- readonly [key: string]: string | undefined;
- };
- readonly other?: {
- readonly [key: string]: string | undefined;
- };
- };
- /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */
- readonly permissions_result: {
- readonly organization?: {
- readonly [key: string]: string | undefined;
- };
- readonly repository?: {
- readonly [key: string]: string | undefined;
- };
- readonly other?: {
- readonly [key: string]: string | undefined;
- };
- };
- /**
- * @description Type of repository selection requested.
- * @enum {string}
- */
- readonly repository_selection: "none" | "all" | "subset";
- /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */
- readonly repository_count: number | null;
- /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */
- readonly repositories: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[] | null;
- /** @description Date and time when the request for access was created. */
- readonly created_at: string;
- /** @description Whether the associated fine-grained personal access token has expired. */
- readonly token_expired: boolean;
- /** @description Date and time when the associated fine-grained personal access token expires. */
- readonly token_expires_at: string | null;
- /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */
- readonly token_last_used_at: string | null;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
};
/**
- * Projects v2 Project
- * @description A projects v2 project
+ * Milestone
+ * @description A collection of related issues and pull requests.
*/
- readonly "projects-v2": {
- readonly id: number;
- readonly node_id: string;
- readonly owner: components["schemas"]["simple-user"];
- readonly creator: components["schemas"]["simple-user"];
- readonly title: string;
- readonly description: string | null;
- readonly public: boolean;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
+ readonly webhooks_milestone: {
+ /** Format: date-time */
readonly closed_at: string | null;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
+ readonly closed_issues: number;
+ /** Format: date-time */
readonly created_at: string;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
- readonly updated_at: string;
- readonly number: number;
- readonly short_description: string | null;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
- readonly deleted_at: string | null;
- readonly deleted_by: components["schemas"]["nullable-simple-user"];
- };
- /**
- * Projects v2 Item Content Type
- * @description The type of content tracked in a project item
- * @enum {string}
- */
- readonly "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue";
- /**
- * Projects v2 Item
- * @description An item belonging to a project
- */
- readonly "projects-v2-item": {
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
readonly id: number;
- readonly node_id?: string;
- readonly project_node_id?: string;
- readonly content_node_id: string;
- readonly content_type: components["schemas"]["projects-v2-item-content-type"];
- readonly creator?: components["schemas"]["simple-user"];
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
- readonly created_at: string;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
/**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
+ * @description The state of the milestone.
+ * @enum {string}
*/
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
readonly updated_at: string;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
- readonly archived_at: string | null;
+ /** Format: uri */
+ readonly url: string;
};
/**
- * @description The reason for resolving the alert.
- * @enum {string|null}
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited";
- readonly "secret-scanning-alert-webhook": {
- readonly number?: components["schemas"]["alert-number"];
- readonly created_at?: components["schemas"]["alert-created-at"];
- readonly updated_at?: components["schemas"]["nullable-alert-updated-at"];
- readonly url?: components["schemas"]["alert-url"];
- readonly html_url?: components["schemas"]["alert-html-url"];
- /**
- * Format: uri
- * @description The REST API URL of the code locations for this alert.
- */
- readonly locations_url?: string;
- readonly resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"];
- /**
- * Format: date-time
- * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- readonly resolved_at?: string | null;
- readonly resolved_by?: components["schemas"]["nullable-simple-user"];
- /** @description An optional comment to resolve an alert. */
- readonly resolution_comment?: string | null;
- /** @description The type of secret that secret scanning detected. */
- readonly secret_type?: string;
- /** @description Whether push protection was bypassed for the detected secret. */
- readonly push_protection_bypassed?: boolean | null;
- readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"];
- /**
- * Format: date-time
- * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- readonly push_protection_bypassed_at?: string | null;
- };
- /** branch protection configuration disabled event */
- readonly "webhook-branch-protection-configuration-disabled": {
- /** @enum {string} */
- readonly action: "disabled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** branch protection configuration enabled event */
- readonly "webhook-branch-protection-configuration-enabled": {
- /** @enum {string} */
- readonly action: "enabled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** branch protection rule created event */
- readonly "webhook-branch-protection-rule-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- /**
- * branch protection rule
- * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.
- */
- readonly rule: {
- readonly admin_enforced: boolean;
- /** @enum {string} */
- readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone";
- readonly authorized_actor_names: string[];
- readonly authorized_actors_only: boolean;
- readonly authorized_dismissal_actors_only: boolean;
- readonly create_protected?: boolean;
- /** Format: date-time */
- readonly created_at: string;
- readonly dismiss_stale_reviews_on_push: boolean;
+ readonly webhooks_issue_2: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ /** User */
+ readonly assignee?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
- readonly ignore_approvals_from_contributors: boolean;
- /** @enum {string} */
- readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone";
- readonly name: string;
- /** @enum {string} */
- readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone";
- readonly repository_id: number;
- readonly require_code_owner_review: boolean;
- /** @description Whether the most recent push must be approved by someone other than the person who pushed it */
- readonly require_last_push_approval?: boolean;
- readonly required_approving_review_count: number;
- /** @enum {string} */
- readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone";
- readonly required_status_checks: string[];
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
/** @enum {string} */
- readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone";
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
/** @enum {string} */
- readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone";
- readonly strict_required_status_checks_policy: boolean;
- /** Format: date-time */
- readonly updated_at: string;
- };
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** branch protection rule deleted event */
- readonly "webhook-branch-protection-rule-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
/**
- * branch protection rule
- * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
*/
- readonly rule: {
- readonly admin_enforced: boolean;
- /** @enum {string} */
- readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone";
- readonly authorized_actor_names: string[];
- readonly authorized_actors_only: boolean;
- readonly authorized_dismissal_actors_only: boolean;
- readonly create_protected?: boolean;
- /** Format: date-time */
- readonly created_at: string;
- readonly dismiss_stale_reviews_on_push: boolean;
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
readonly id: number;
- readonly ignore_approvals_from_contributors: boolean;
- /** @enum {string} */
- readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone";
+ /** @description The name of the label. */
readonly name: string;
- /** @enum {string} */
- readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone";
- readonly repository_id: number;
- readonly require_code_owner_review: boolean;
- /** @description Whether the most recent push must be approved by someone other than the person who pushed it */
- readonly require_last_push_approval?: boolean;
- readonly required_approving_review_count: number;
- /** @enum {string} */
- readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone";
- readonly required_status_checks: string[];
- /** @enum {string} */
- readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone";
- readonly strict_required_status_checks_policy: boolean;
- /** Format: date-time */
- readonly updated_at: string;
- };
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** branch protection rule edited event */
- readonly "webhook-branch-protection-rule-edited": {
- /** @enum {string} */
- readonly action: "edited";
- /** @description If the action was `edited`, the changes to the rule. */
- readonly changes?: {
- readonly admin_enforced?: {
- readonly from: boolean | null;
- };
- readonly authorized_actor_names?: {
- readonly from: string[];
- };
- readonly authorized_actors_only?: {
- readonly from: boolean | null;
- };
- readonly authorized_dismissal_actors_only?: {
- readonly from: boolean | null;
- };
- readonly linear_history_requirement_enforcement_level?: {
- /** @enum {string} */
- readonly from: "off" | "non_admins" | "everyone";
- };
- readonly required_status_checks?: {
- readonly from: string[];
- };
- readonly required_status_checks_enforcement_level?: {
- /** @enum {string} */
- readonly from: "off" | "non_admins" | "everyone";
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
/**
- * branch protection rule
- * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.
+ * Milestone
+ * @description A collection of related issues and pull requests.
*/
- readonly rule: {
- readonly admin_enforced: boolean;
- /** @enum {string} */
- readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone";
- readonly authorized_actor_names: string[];
- readonly authorized_actors_only: boolean;
- readonly authorized_dismissal_actors_only: boolean;
- readonly create_protected?: boolean;
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
/** Format: date-time */
readonly created_at: string;
- readonly dismiss_stale_reviews_on_push: boolean;
- readonly id: number;
- readonly ignore_approvals_from_contributors: boolean;
- /** @enum {string} */
- readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone";
- readonly name: string;
- /** @enum {string} */
- readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone";
- readonly repository_id: number;
- readonly require_code_owner_review: boolean;
- /** @description Whether the most recent push must be approved by someone other than the person who pushed it */
- readonly require_last_push_approval?: boolean;
- readonly required_approving_review_count: number;
- /** @enum {string} */
- readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone";
- readonly required_status_checks: string[];
- /** @enum {string} */
- readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone";
- readonly strict_required_status_checks_policy: boolean;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
/** Format: date-time */
readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ readonly node_id: string;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
};
- readonly sender: components["schemas"]["simple-user-webhooks"];
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Format: uri */
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
};
- /** Check Run Completed Event */
- readonly "webhook-check-run-completed": {
+ /** User */
+ readonly webhooks_user_mannequin: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
/** @enum {string} */
- readonly action?: "completed";
- readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /**
- * Check Run Completed Event
- * @description The check_run.completed webhook encoded with URL encoding
- */
- readonly "webhook-check-run-completed-form-encoded": {
- /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** Marketplace Purchase */
+ readonly webhooks_marketplace_purchase: {
+ readonly account: {
+ readonly id: number;
+ readonly login: string;
+ readonly node_id: string;
+ readonly organization_billing_email: string | null;
+ readonly type: string;
+ };
+ readonly billing_cycle: string;
+ readonly free_trial_ends_on: string | null;
+ readonly next_billing_date: string | null;
+ readonly on_free_trial: boolean;
+ readonly plan: {
+ readonly bullets: (string | null)[];
+ readonly description: string;
+ readonly has_free_trial: boolean;
+ readonly id: number;
+ readonly monthly_price_in_cents: number;
+ readonly name: string;
+ /** @enum {string} */
+ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ readonly unit_name: string | null;
+ readonly yearly_price_in_cents: number;
+ };
+ readonly unit_count: number;
};
- /** Check Run Created Event */
- readonly "webhook-check-run-created": {
- /** @enum {string} */
- readonly action?: "created";
- readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
+ /** Marketplace Purchase */
+ readonly webhooks_previous_marketplace_purchase: {
+ readonly account: {
+ readonly id: number;
+ readonly login: string;
+ readonly node_id: string;
+ readonly organization_billing_email: string | null;
+ readonly type: string;
+ };
+ readonly billing_cycle: string;
+ readonly free_trial_ends_on: unknown;
+ readonly next_billing_date?: string | null;
+ readonly on_free_trial: boolean;
+ readonly plan: {
+ readonly bullets: string[];
+ readonly description: string;
+ readonly has_free_trial: boolean;
+ readonly id: number;
+ readonly monthly_price_in_cents: number;
+ readonly name: string;
+ /** @enum {string} */
+ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ readonly unit_name: string | null;
+ readonly yearly_price_in_cents: number;
+ };
+ readonly unit_count: number;
};
/**
- * Check Run Created Event
- * @description The check_run.created webhook encoded with URL encoding
+ * Team
+ * @description Groups of organization members that gives permissions on specified repositories.
*/
- readonly "webhook-check-run-created-form-encoded": {
- /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
- };
- /** Check Run Requested Action Event */
- readonly "webhook-check-run-requested-action": {
+ readonly webhooks_team: {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ readonly notification_setting: "notifications_enabled" | "notifications_disabled";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
/** @enum {string} */
- readonly action: "requested_action";
- readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- /** @description The action requested by the user. */
- readonly requested_action?: {
- /** @description The integrator reference of the action requested by the user. */
- readonly identifier?: string;
- };
- readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly privacy?: "open" | "closed" | "secret";
+ /** @enum {string} */
+ readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
+ /** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url?: string;
};
/**
- * Check Run Requested Action Event
- * @description The check_run.requested_action webhook encoded with URL encoding
+ * Merge Group
+ * @description A group of pull requests that the merge queue has grouped together to be merged.
+ *
*/
- readonly "webhook-check-run-requested-action-form-encoded": {
- /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
- };
- /** Check Run Re-Requested Event */
- readonly "webhook-check-run-rerequested": {
- /** @enum {string} */
- readonly action?: "rerequested";
- readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly "merge-group": {
+ /** @description The SHA of the merge group. */
+ readonly head_sha: string;
+ /** @description The full ref of the merge group. */
+ readonly head_ref: string;
+ /** @description The SHA of the merge group's parent commit. */
+ readonly base_sha: string;
+ /** @description The full ref of the branch the merge group will be merged into. */
+ readonly base_ref: string;
+ readonly head_commit: components["schemas"]["simple-commit"];
};
/**
- * Check Run Re-Requested Event
- * @description The check_run.rerequested webhook encoded with URL encoding
+ * Repository
+ * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
+ * when the event occurs from activity in a repository.
*/
- readonly "webhook-check-run-rerequested-form-encoded": {
- /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
- };
- /** check_suite completed event */
- readonly "webhook-check-suite-completed": {
- /** @enum {string} */
- readonly action: "completed";
- /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
- readonly check_suite: {
- readonly after: string | null;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly app: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- };
- readonly before: string | null;
- /** Format: uri */
- readonly check_runs_url: string;
- /**
- * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.
- * @enum {string|null}
- */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure";
- /** Format: date-time */
- readonly created_at: string;
- /** @description The head branch name the changes are on. */
- readonly head_branch: string | null;
- /** SimpleCommit */
- readonly head_commit: {
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly author: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly committer: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- readonly id: string;
- readonly message: string;
- readonly timestamp: string;
- readonly tree_id: string;
- };
- /** @description The SHA of the head commit that is being checked. */
- readonly head_sha: string;
- readonly id: number;
- readonly latest_check_runs_count: number;
- readonly node_id: string;
- /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly rerequestable?: boolean;
- readonly runs_rerequestable?: boolean;
- /**
- * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
- * @enum {string|null}
- */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | null | "pending";
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL that points to the check suite API resource.
- */
- readonly url: string;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** check_suite requested event */
- readonly "webhook-check-suite-requested": {
- /** @enum {string} */
- readonly action: "requested";
- /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
- readonly check_suite: {
- readonly after: string | null;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly app: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- };
- readonly before: string | null;
- /** Format: uri */
- readonly check_runs_url: string;
- /**
- * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.
- * @enum {string|null}
- */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped";
- /** Format: date-time */
- readonly created_at: string;
- /** @description The head branch name the changes are on. */
- readonly head_branch: string | null;
- /** SimpleCommit */
- readonly head_commit: {
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly author: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly committer: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- readonly id: string;
- readonly message: string;
- readonly timestamp: string;
- readonly tree_id: string;
- };
- /** @description The SHA of the head commit that is being checked. */
- readonly head_sha: string;
- readonly id: number;
- readonly latest_check_runs_count: number;
- readonly node_id: string;
- /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly rerequestable?: boolean;
- readonly runs_rerequestable?: boolean;
- /**
- * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
- * @enum {string|null}
- */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | null;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL that points to the check suite API resource.
- */
- readonly url: string;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** check_suite rerequested event */
- readonly "webhook-check-suite-rerequested": {
- /** @enum {string} */
- readonly action: "rerequested";
- /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
- readonly check_suite: {
- readonly after: string | null;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly app: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- };
- readonly before: string | null;
- /** Format: uri */
- readonly check_runs_url: string;
- /**
- * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.
- * @enum {string|null}
- */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
- /** Format: date-time */
- readonly created_at: string;
- /** @description The head branch name the changes are on. */
- readonly head_branch: string | null;
- /** SimpleCommit */
- readonly head_commit: {
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly author: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly committer: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- readonly id: string;
- readonly message: string;
- readonly timestamp: string;
- readonly tree_id: string;
- };
- /** @description The SHA of the head commit that is being checked. */
- readonly head_sha: string;
- readonly id: number;
- readonly latest_check_runs_count: number;
- readonly node_id: string;
- /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly rerequestable?: boolean;
- readonly runs_rerequestable?: boolean;
- /**
- * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
- * @enum {string|null}
- */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | null;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL that points to the check suite API resource.
- */
- readonly url: string;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** code_scanning_alert appeared_in_branch event */
- readonly "webhook-code-scanning-alert-appeared-in-branch": {
- /** @enum {string} */
- readonly action: "appeared_in_branch";
- /** @description The code scanning alert involved in the event. */
- readonly alert: {
- /**
- * Format: date-time
- * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- readonly dismissed_at: string | null;
- /** User */
- readonly dismissed_by: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * @description The reason for dismissing or closing the alert.
- * @enum {string|null}
- */
- readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
- /**
- * Format: uri
- * @description The GitHub URL of the alert resource.
- */
- readonly html_url: string;
- /** Alert Instance */
- readonly most_recent_instance?: {
- /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
- /** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: string[];
- readonly commit_sha?: string;
- /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
- };
- readonly message?: {
- readonly text?: string;
- };
- /** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- } | null;
- /** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
- /** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity: "none" | "note" | "warning" | "error" | null;
- };
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- readonly tool: {
- /** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
- /** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
- };
- /** Format: uri */
- readonly url: string;
- };
- /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly commit_oid: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly ref: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** code_scanning_alert closed_by_user event */
- readonly "webhook-code-scanning-alert-closed-by-user": {
- /** @enum {string} */
- readonly action: "closed_by_user";
- /** @description The code scanning alert involved in the event. */
- readonly alert: {
- /**
- * Format: date-time
- * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- readonly dismissed_at: string;
- /** User */
- readonly dismissed_by: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * @description The reason for dismissing or closing the alert.
- * @enum {string|null}
- */
- readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
- /**
- * Format: uri
- * @description The GitHub URL of the alert resource.
- */
- readonly html_url: string;
- /** Alert Instance */
- readonly most_recent_instance?: {
- /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
- /** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: string[];
- readonly commit_sha?: string;
- /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
- };
- readonly message?: {
- readonly text?: string;
- };
- /** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- } | null;
- /** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
- /** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- readonly full_description?: string;
- readonly help?: string | null;
- /** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- readonly name?: string;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity: "none" | "note" | "warning" | "error" | null;
- readonly tags?: string[] | null;
- };
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "dismissed" | "fixed";
- readonly tool: {
- readonly guid?: string | null;
- /** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
- /** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
- };
- /** Format: uri */
- readonly url: string;
- };
- /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly commit_oid: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly ref: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** code_scanning_alert created event */
- readonly "webhook-code-scanning-alert-created": {
- /** @enum {string} */
- readonly action: "created";
- /** @description The code scanning alert involved in the event. */
- readonly alert: {
- /**
- * Format: date-time
- * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
- */
- readonly created_at: string | null;
- /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly dismissed_at: unknown;
- readonly dismissed_by: unknown;
- readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
- /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
- readonly dismissed_reason: unknown;
- readonly fixed_at?: unknown;
- /**
- * Format: uri
- * @description The GitHub URL of the alert resource.
- */
- readonly html_url: string;
- readonly instances_url?: string;
- /** Alert Instance */
- readonly most_recent_instance?: {
- /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
- /** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: string[];
- readonly commit_sha?: string;
- /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
- };
- readonly message?: {
- readonly text?: string;
- };
- /** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- } | null;
- /** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
- /** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- readonly full_description?: string;
- readonly help?: string | null;
- /** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- readonly name?: string;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity: "none" | "note" | "warning" | "error" | null;
- readonly tags?: string[] | null;
- };
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed";
- readonly tool: {
- readonly guid?: string | null;
- /** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
- /** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
- } | null;
- readonly updated_at?: string | null;
- /** Format: uri */
- readonly url: string;
- };
- /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly commit_oid: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly ref: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** code_scanning_alert fixed event */
- readonly "webhook-code-scanning-alert-fixed": {
- /** @enum {string} */
- readonly action: "fixed";
- /** @description The code scanning alert involved in the event. */
- readonly alert: {
- /**
- * Format: date-time
- * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- readonly dismissed_at: string | null;
- /** User */
- readonly dismissed_by: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * @description The reason for dismissing or closing the alert.
- * @enum {string|null}
- */
- readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
- /**
- * Format: uri
- * @description The GitHub URL of the alert resource.
- */
- readonly html_url: string;
- /** Format: uri */
- readonly instances_url?: string;
- /** Alert Instance */
- readonly most_recent_instance?: {
- /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
- /** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: string[];
- readonly commit_sha?: string;
- /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
- };
- readonly message?: {
- readonly text?: string;
- };
- /** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- } | null;
- /** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
- /** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- readonly full_description?: string;
- readonly help?: string | null;
- /** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- readonly name?: string;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity: "none" | "note" | "warning" | "error" | null;
- readonly tags?: string[] | null;
- };
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "fixed";
- readonly tool: {
- readonly guid?: string | null;
- /** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
- /** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
- };
- /** Format: uri */
- readonly url: string;
- };
- /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly commit_oid: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly ref: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** code_scanning_alert reopened event */
- readonly "webhook-code-scanning-alert-reopened": {
- /** @enum {string} */
- readonly action: "reopened";
- /** @description The code scanning alert involved in the event. */
- readonly alert: {
- /**
- * Format: date-time
- * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
- */
- readonly created_at: string;
- /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly dismissed_at: string | null;
- readonly dismissed_by: Record;
- /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
- readonly dismissed_reason: string | null;
- /**
- * Format: uri
- * @description The GitHub URL of the alert resource.
- */
- readonly html_url: string;
- /** Alert Instance */
- readonly most_recent_instance?: {
- /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
- /** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: string[];
- readonly commit_sha?: string;
- /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
- };
- readonly message?: {
- readonly text?: string;
- };
- /** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- } | null;
- /** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
- /** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- readonly full_description?: string;
- readonly help?: string | null;
- /** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- readonly name?: string;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity: "none" | "note" | "warning" | "error" | null;
- readonly tags?: string[] | null;
- };
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- readonly tool: {
- readonly guid?: string | null;
- /** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
- /** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
- };
- /** Format: uri */
- readonly url: string;
- } | null;
- /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly commit_oid: string | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly ref: string | null;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** code_scanning_alert reopened_by_user event */
- readonly "webhook-code-scanning-alert-reopened-by-user": {
- /** @enum {string} */
- readonly action: "reopened_by_user";
- /** @description The code scanning alert involved in the event. */
- readonly alert: {
- /**
- * Format: date-time
- * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
- */
- readonly created_at: string;
- /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly dismissed_at: unknown;
- readonly dismissed_by: unknown;
- /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
- readonly dismissed_reason: unknown;
- /**
- * Format: uri
- * @description The GitHub URL of the alert resource.
- */
- readonly html_url: string;
- /** Alert Instance */
- readonly most_recent_instance?: {
- /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
- /** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: string[];
- readonly commit_sha?: string;
- /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
- };
- readonly message?: {
- readonly text?: string;
- };
- /** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- } | null;
- /** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
- /** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity: "none" | "note" | "warning" | "error" | null;
- };
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "fixed";
- readonly tool: {
- /** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
- /** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
- };
- /** Format: uri */
- readonly url: string;
- };
- /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly commit_oid: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly ref: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** commit_comment created event */
- readonly "webhook-commit-comment-created": {
- /**
- * @description The action performed. Can be `created`.
- * @enum {string}
- */
- readonly action: "created";
- /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description The text of the comment. */
- readonly body: string;
- /** @description The SHA of the commit to which the comment applies. */
- readonly commit_id: string;
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- /** @description The ID of the commit comment. */
- readonly id: number;
- /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly line: number | null;
- /** @description The node ID of the commit comment. */
- readonly node_id: string;
- /** @description The relative path of the file to which the comment applies. */
- readonly path: string | null;
- /** @description The line index in the diff to which the comment applies. */
- readonly position: number | null;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** create event */
- readonly "webhook-create": {
- /** @description The repository's current description. */
- readonly description: string | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The name of the repository's default branch (usually `main`). */
- readonly master_branch: string;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The pusher type for the event. Can be either `user` or a deploy key. */
- readonly pusher_type: string;
- /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */
- readonly ref: string;
- /**
- * @description The type of Git ref object created in the repository.
- * @enum {string}
- */
- readonly ref_type: "tag" | "branch";
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** custom property created event */
- readonly "webhook-custom-property-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly definition: components["schemas"]["org-custom-property"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** custom property deleted event */
- readonly "webhook-custom-property-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly definition: {
- /** @description The name of the property that was deleted. */
- readonly property_name: string;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** custom property updated event */
- readonly "webhook-custom-property-updated": {
- /** @enum {string} */
- readonly action: "updated";
- readonly definition: components["schemas"]["org-custom-property"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** Custom property values updated event */
- readonly "webhook-custom-property-values-updated": {
- /** @enum {string} */
- readonly action: "updated";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- /** @description The new custom property values for the repository. */
- readonly new_property_values: components["schemas"]["custom-property-value"][];
- /** @description The old custom property values for the repository. */
- readonly old_property_values: components["schemas"]["custom-property-value"][];
- };
- /** delete event */
- readonly "webhook-delete": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The pusher type for the event. Can be either `user` or a deploy key. */
- readonly pusher_type: string;
- /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */
- readonly ref: string;
- /**
- * @description The type of Git ref object deleted in the repository.
- * @enum {string}
- */
- readonly ref_type: "tag" | "branch";
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert auto-dismissed event */
- readonly "webhook-dependabot-alert-auto-dismissed": {
- /** @enum {string} */
- readonly action: "auto_dismissed";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert auto-reopened event */
- readonly "webhook-dependabot-alert-auto-reopened": {
- /** @enum {string} */
- readonly action: "auto_reopened";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert created event */
- readonly "webhook-dependabot-alert-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert dismissed event */
- readonly "webhook-dependabot-alert-dismissed": {
- /** @enum {string} */
- readonly action: "dismissed";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert fixed event */
- readonly "webhook-dependabot-alert-fixed": {
- /** @enum {string} */
- readonly action: "fixed";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert reintroduced event */
- readonly "webhook-dependabot-alert-reintroduced": {
- /** @enum {string} */
- readonly action: "reintroduced";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert reopened event */
- readonly "webhook-dependabot-alert-reopened": {
- /** @enum {string} */
- readonly action: "reopened";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** deploy_key created event */
- readonly "webhook-deploy-key-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */
- readonly key: {
- readonly added_by?: string | null;
- readonly created_at: string;
- readonly id: number;
- readonly key: string;
- readonly last_used?: string | null;
- readonly read_only: boolean;
- readonly title: string;
- /** Format: uri */
- readonly url: string;
- readonly verified: boolean;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** deploy_key deleted event */
- readonly "webhook-deploy-key-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */
- readonly key: {
- readonly added_by?: string | null;
- readonly created_at: string;
- readonly id: number;
- readonly key: string;
- readonly last_used?: string | null;
- readonly read_only: boolean;
- readonly title: string;
- /** Format: uri */
- readonly url: string;
- readonly verified: boolean;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** deployment created event */
- readonly "webhook-deployment-created": {
- /** @enum {string} */
- readonly action: "created";
- /**
- * Deployment
- * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).
- */
- readonly deployment: {
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- readonly environment: string;
- readonly id: number;
- readonly node_id: string;
- readonly original_environment: string;
- readonly payload: Record | string;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly production_environment?: boolean;
- readonly ref: string;
- /** Format: uri */
- readonly repository_url: string;
- readonly sha: string;
- /** Format: uri */
- readonly statuses_url: string;
- readonly task: string;
- readonly transient_environment?: boolean;
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- /** Workflow */
- readonly workflow: {
- /** Format: uri */
- readonly badge_url: string;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly state: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- /** Deployment Workflow Run */
- readonly workflow_run: {
- /** User */
- readonly actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
- /** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
- /** Format: date-time */
- readonly created_at: string;
- readonly display_title: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: unknown;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: unknown;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: unknown;
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly referenced_workflows?: {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
- }[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: unknown;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
- /** Format: date-time */
- readonly run_started_at: string;
- /** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
- /** User */
- readonly triggering_actor?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
- } | null;
- };
- /** deployment protection rule requested event */
- readonly "webhook-deployment-protection-rule-requested": {
- /** @enum {string} */
- readonly action?: "requested";
- /** @description The name of the environment that has the deployment protection rule. */
- readonly environment?: string;
- /** @description The event that triggered the deployment protection rule. */
- readonly event?: string;
- /**
- * Format: uri
- * @description The URL to review the deployment protection rule.
- */
- readonly deployment_callback_url?: string;
- readonly deployment?: components["schemas"]["deployment"];
- readonly pull_requests?: components["schemas"]["pull-request"][];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- readonly "webhook-deployment-review-approved": {
- /** @enum {string} */
- readonly action: "approved";
- readonly approver?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly comment?: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly reviewers?: {
- /** User */
- readonly reviewer?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @enum {string} */
- readonly type?: "User";
- }[];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly since: string;
- readonly workflow_job_run?: {
- readonly conclusion: unknown;
- readonly created_at: string;
- readonly environment: string;
- readonly html_url: string;
- readonly id: number;
- readonly name: unknown;
- readonly status: string;
- readonly updated_at: string;
- };
- readonly workflow_job_runs?: {
- readonly conclusion?: unknown;
- readonly created_at?: string;
- readonly environment?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly name?: string | null;
- readonly status?: string;
- readonly updated_at?: string;
- }[];
- /** Deployment Workflow Run */
- readonly workflow_run: {
- /** User */
- readonly actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
- /** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
- /** Format: date-time */
- readonly created_at: string;
- readonly display_title: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: Record;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: string | null;
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly referenced_workflows?: {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
- }[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
- /** Format: date-time */
- readonly run_started_at: string;
- /** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
- /** User */
- readonly triggering_actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
- } | null;
- };
- readonly "webhook-deployment-review-rejected": {
- /** @enum {string} */
- readonly action: "rejected";
- readonly approver?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly comment?: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly reviewers?: {
- /** User */
- readonly reviewer?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @enum {string} */
- readonly type?: "User";
- }[];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly since: string;
- readonly workflow_job_run?: {
- readonly conclusion: unknown;
- readonly created_at: string;
- readonly environment: string;
- readonly html_url: string;
- readonly id: number;
- readonly name: unknown;
- readonly status: string;
- readonly updated_at: string;
- };
- readonly workflow_job_runs?: {
- readonly conclusion?: string | null;
- readonly created_at?: string;
- readonly environment?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly name?: string | null;
- readonly status?: string;
- readonly updated_at?: string;
- }[];
- /** Deployment Workflow Run */
- readonly workflow_run: {
- /** User */
- readonly actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
- /** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
- /** Format: date-time */
- readonly created_at: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: Record;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: string | null;
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly referenced_workflows?: {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
- }[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
- /** Format: date-time */
- readonly run_started_at: string;
- /** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting";
- /** User */
- readonly triggering_actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
- readonly display_title: string;
- } | null;
- };
- readonly "webhook-deployment-review-requested": {
- /** @enum {string} */
- readonly action: "requested";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly environment: string;
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- /** User */
- readonly requestor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly reviewers: {
- /** User */
- readonly reviewer?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login?: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @enum {string} */
- readonly type?: "User" | "Team";
- }[];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly since: string;
- readonly workflow_job_run: {
- readonly conclusion: unknown;
- readonly created_at: string;
- readonly environment: string;
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly status: string;
- readonly updated_at: string;
- };
- /** Deployment Workflow Run */
- readonly workflow_run: {
- /** User */
- readonly actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
- /** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
- /** Format: date-time */
- readonly created_at: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: Record;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: string | null;
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly referenced_workflows?: {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
- }[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
- /** Format: date-time */
- readonly run_started_at: string;
- /** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
- /** User */
- readonly triggering_actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
- readonly display_title: string;
- } | null;
- };
- /** deployment_status created event */
- readonly "webhook-deployment-status-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly check_run?: {
- /** Format: date-time */
- readonly completed_at: string | null;
- /**
- * @description The result of the completed check run. This value will be `null` until the check run has completed.
- * @enum {string|null}
- */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null;
- /** Format: uri */
- readonly details_url: string;
- readonly external_id: string;
- /** @description The SHA of the commit that is being checked. */
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- /** @description The id of the check. */
- readonly id: number;
- /** @description The name of the check run. */
- readonly name: string;
- readonly node_id: string;
- /** Format: date-time */
- readonly started_at: string;
- /**
- * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`.
- * @enum {string}
- */
- readonly status: "queued" | "in_progress" | "completed" | "waiting" | "pending";
- /** Format: uri */
- readonly url: string;
- } | null;
- /**
- * Deployment
- * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).
- */
- readonly deployment: {
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- readonly environment: string;
- readonly id: number;
- readonly node_id: string;
- readonly original_environment: string;
- readonly payload: (string | Record) | null;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly production_environment?: boolean;
- readonly ref: string;
- /** Format: uri */
- readonly repository_url: string;
- readonly sha: string;
- /** Format: uri */
- readonly statuses_url: string;
- readonly task: string;
- readonly transient_environment?: boolean;
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */
- readonly deployment_status: {
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: uri */
- readonly deployment_url: string;
- /** @description The optional human-readable description added to the status. */
- readonly description: string;
- readonly environment: string;
- /** Format: uri */
- readonly environment_url?: string;
- readonly id: number;
- /** Format: uri */
- readonly log_url?: string;
- readonly node_id: string;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- /** Format: uri */
- readonly repository_url: string;
- /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */
- readonly state: string;
- /** @description The optional link added to the status. */
- readonly target_url: string;
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- /** Workflow */
- readonly workflow?: {
- /** Format: uri */
- readonly badge_url: string;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly state: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- /** Deployment Workflow Run */
- readonly workflow_run?: {
- /** User */
- readonly actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
- /** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure";
- /** Format: date-time */
- readonly created_at: string;
- readonly display_title: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: unknown;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: unknown;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: unknown;
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly referenced_workflows?: {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
- }[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: unknown;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
- /** Format: date-time */
- readonly run_started_at: string;
- /** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
- /** User */
- readonly triggering_actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
- } | null;
- };
- /** discussion answered event */
- readonly "webhook-discussion-answered": {
- /** @enum {string} */
- readonly action: "answered";
- readonly answer: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string;
- readonly child_comment_count: number;
- /** Format: date-time */
- readonly created_at: string;
- readonly discussion_id: number;
- readonly html_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly parent_id: unknown;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion category changed event */
- readonly "webhook-discussion-category-changed": {
- /** @enum {string} */
- readonly action: "category_changed";
- readonly changes: {
- readonly category: {
- readonly from: {
- /** Format: date-time */
- readonly created_at: string;
- readonly description: string;
- readonly emoji: string;
- readonly id: number;
- readonly is_answerable: boolean;
- readonly name: string;
- readonly node_id?: string;
- readonly repository_id: number;
- readonly slug: string;
- readonly updated_at: string;
- };
- };
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion closed event */
- readonly "webhook-discussion-closed": {
- /** @enum {string} */
- readonly action: "closed";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion_comment created event */
- readonly "webhook-discussion-comment-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string;
- readonly child_comment_count: number;
- readonly created_at: string;
- readonly discussion_id: number;
- readonly html_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly parent_id: number | null;
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- readonly updated_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion_comment deleted event */
- readonly "webhook-discussion-comment-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string;
- readonly child_comment_count: number;
- readonly created_at: string;
- readonly discussion_id: number;
- readonly html_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly parent_id: number | null;
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- readonly updated_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion_comment edited event */
- readonly "webhook-discussion-comment-edited": {
- /** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly body: {
- readonly from: string;
- };
- };
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string;
- readonly child_comment_count: number;
- readonly created_at: string;
- readonly discussion_id: number;
- readonly html_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly parent_id: number | null;
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- readonly updated_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion created event */
- readonly "webhook-discussion-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly discussion: {
- readonly active_lock_reason: string | null;
- readonly answer_chosen_at: string | null;
- /** User */
- readonly answer_chosen_by: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly answer_html_url: string | null;
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string | null;
- readonly category: {
- /** Format: date-time */
- readonly created_at: string;
- readonly description: string;
- readonly emoji: string;
- readonly id: number;
- readonly is_answerable: boolean;
- readonly name: string;
- readonly node_id?: string;
- readonly repository_id: number;
- readonly slug: string;
- readonly updated_at: string;
- };
- readonly comments: number;
- /** Format: date-time */
- readonly created_at: string;
- readonly html_url: string;
- readonly id: number;
- readonly locked: boolean;
- readonly node_id: string;
- readonly number: number;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- /** @enum {string} */
- readonly state: "open" | "locked" | "converting" | "transferring";
- readonly timeline_url?: string;
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: unknown;
- readonly answer_chosen_at: unknown;
- readonly answer_chosen_by: unknown;
- readonly answer_html_url: string | null;
- readonly author_association?: string;
- readonly body?: string | null;
- readonly category?: {
- readonly created_at?: string;
- readonly description?: string;
- readonly emoji?: string;
- readonly id?: number;
- readonly is_answerable?: boolean;
- readonly name?: string;
- readonly node_id?: string;
- readonly repository_id?: number;
- readonly slug?: string;
- readonly updated_at?: string;
- };
- readonly comments?: number;
- readonly created_at?: string;
- readonly html_url?: string;
- readonly id?: number;
- /** @enum {boolean} */
- readonly locked: false;
- readonly node_id?: string;
- readonly number?: number;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- /** @enum {string} */
- readonly state: "open" | "converting" | "transferring";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion deleted event */
- readonly "webhook-discussion-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion edited event */
- readonly "webhook-discussion-edited": {
- /** @enum {string} */
- readonly action: "edited";
- readonly changes?: {
- readonly body?: {
- readonly from: string;
- };
- readonly title?: {
- readonly from: string;
- };
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion labeled event */
- readonly "webhook-discussion-labeled": {
- /** @enum {string} */
- readonly action: "labeled";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** Label */
- readonly label: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion locked event */
- readonly "webhook-discussion-locked": {
- /** @enum {string} */
- readonly action: "locked";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion pinned event */
- readonly "webhook-discussion-pinned": {
- /** @enum {string} */
- readonly action: "pinned";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion reopened event */
- readonly "webhook-discussion-reopened": {
- /** @enum {string} */
- readonly action: "reopened";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion transferred event */
- readonly "webhook-discussion-transferred": {
- /** @enum {string} */
- readonly action: "transferred";
- readonly changes: {
- readonly new_discussion: components["schemas"]["discussion"];
- readonly new_repository: components["schemas"]["repository-webhooks"];
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion unanswered event */
- readonly "webhook-discussion-unanswered": {
- /** @enum {string} */
- readonly action: "unanswered";
- readonly discussion: components["schemas"]["discussion"];
- readonly old_answer: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string;
- readonly child_comment_count: number;
- /** Format: date-time */
- readonly created_at: string;
- readonly discussion_id: number;
- readonly html_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly parent_id: unknown;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion unlabeled event */
- readonly "webhook-discussion-unlabeled": {
- /** @enum {string} */
- readonly action: "unlabeled";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** Label */
- readonly label: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion unlocked event */
- readonly "webhook-discussion-unlocked": {
- /** @enum {string} */
- readonly action: "unlocked";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion unpinned event */
- readonly "webhook-discussion-unpinned": {
- /** @enum {string} */
- readonly action: "unpinned";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /**
- * fork event
- * @description A user forks a repository.
- */
- readonly "webhook-fork": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */
- readonly forkee: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
- /** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
- /** Format: uri-template */
- readonly assignees_url: string;
- /** Format: uri-template */
- readonly blobs_url: string;
- /** Format: uri-template */
- readonly branches_url: string;
- /** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
- /** Format: uri-template */
- readonly commits_url: string;
- /** Format: uri-template */
- readonly compare_url: string;
- /** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
- };
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
- /** Format: uri */
- readonly downloads_url: string;
- /** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
- /** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
- /** Format: uri-template */
- readonly git_tags_url: string;
- /** Format: uri */
- readonly git_url: string;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
- readonly homepage: string | null;
- /** Format: uri */
- readonly hooks_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
- /** Format: uri-template */
- readonly issues_url: string;
- /** Format: uri-template */
- readonly keys_url: string;
- /** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
- /** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
- /** Format: uri */
- readonly merges_url: string;
- /** Format: uri-template */
- readonly milestones_url: string;
- /** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- };
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
- /** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
- /** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
- /** Format: uri */
- readonly subscription_url: string;
- /** Format: uri */
- readonly svn_url: string;
- /** Format: uri */
- readonly tags_url: string;
- /** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
- /** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
- } & {
- readonly allow_forking?: boolean;
- readonly archive_url?: string;
- readonly archived?: boolean;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly clone_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly created_at?: string;
- readonly default_branch?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly disabled?: boolean;
- readonly downloads_url?: string;
- readonly events_url?: string;
- /** @enum {boolean} */
- readonly fork?: true;
- readonly forks?: number;
- readonly forks_count?: number;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly git_url?: string;
- readonly has_downloads?: boolean;
- readonly has_issues?: boolean;
- readonly has_pages?: boolean;
- readonly has_projects?: boolean;
- readonly has_wiki?: boolean;
- readonly homepage?: string | null;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly is_template?: boolean;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly language?: unknown;
- readonly languages_url?: string;
- readonly license?: Record;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly mirror_url?: unknown;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly open_issues?: number;
- readonly open_issues_count?: number;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly public?: boolean;
- readonly pulls_url?: string;
- readonly pushed_at?: string;
- readonly releases_url?: string;
- readonly size?: number;
- readonly ssh_url?: string;
- readonly stargazers_count?: number;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly svn_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly topics?: unknown[];
- readonly trees_url?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly visibility?: string;
- readonly watchers?: number;
- readonly watchers_count?: number;
- };
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** github_app_authorization revoked event */
- readonly "webhook-github-app-authorization-revoked": {
- /** @enum {string} */
- readonly action: "revoked";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** gollum event */
- readonly "webhook-gollum": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The pages that were updated. */
- readonly pages: {
- /**
- * @description The action that was performed on the page. Can be `created` or `edited`.
- * @enum {string}
- */
- readonly action: "created" | "edited";
- /**
- * Format: uri
- * @description Points to the HTML wiki page.
- */
- readonly html_url: string;
- /** @description The name of the page. */
- readonly page_name: string;
- /** @description The latest commit SHA of the page. */
- readonly sha: string;
- readonly summary: string | null;
- /** @description The current page title. */
- readonly title: string;
- }[];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** installation created event */
- readonly "webhook-installation-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects that the installation can access. */
- readonly repositories?: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- /** User */
- readonly requester?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** installation deleted event */
- readonly "webhook-installation-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects that the installation can access. */
- readonly repositories?: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly requester?: unknown;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** installation new_permissions_accepted event */
- readonly "webhook-installation-new-permissions-accepted": {
- /** @enum {string} */
- readonly action: "new_permissions_accepted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects that the installation can access. */
- readonly repositories?: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly requester?: unknown;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** installation_repositories added event */
- readonly "webhook-installation-repositories-added": {
- /** @enum {string} */
- readonly action: "added";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects, which were added to the installation. */
- readonly repositories_added: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- /** @description An array of repository objects, which were removed from the installation. */
- readonly repositories_removed: {
- readonly full_name?: string;
- /** @description Unique identifier of the repository */
- readonly id?: number;
- /** @description The name of the repository. */
- readonly name?: string;
- readonly node_id?: string;
- /** @description Whether the repository is private or public. */
- readonly private?: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- /**
- * @description Describe whether all repositories have been selected or there's a selection involved
- * @enum {string}
- */
- readonly repository_selection: "all" | "selected";
- /** User */
- readonly requester: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** installation_repositories removed event */
- readonly "webhook-installation-repositories-removed": {
- /** @enum {string} */
- readonly action: "removed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects, which were added to the installation. */
- readonly repositories_added: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- /** @description An array of repository objects, which were removed from the installation. */
- readonly repositories_removed: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- /**
- * @description Describe whether all repositories have been selected or there's a selection involved
- * @enum {string}
- */
- readonly repository_selection: "all" | "selected";
- /** User */
- readonly requester: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** installation suspend event */
- readonly "webhook-installation-suspend": {
- /** @enum {string} */
- readonly action: "suspend";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects that the installation can access. */
- readonly repositories?: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly requester?: unknown;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- readonly "webhook-installation-target-renamed": {
- readonly account: {
- readonly archived_at?: string | null;
- readonly avatar_url: string;
- readonly created_at?: string;
- readonly description?: unknown;
- readonly events_url?: string;
- readonly followers?: number;
- readonly followers_url?: string;
- readonly following?: number;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly has_organization_projects?: boolean;
- readonly has_repository_projects?: boolean;
- readonly hooks_url?: string;
- readonly html_url: string;
- readonly id: number;
- readonly is_verified?: boolean;
- readonly issues_url?: string;
- readonly login?: string;
- readonly members_url?: string;
- readonly name?: string;
- readonly node_id: string;
- readonly organizations_url?: string;
- readonly public_gists?: number;
- readonly public_members_url?: string;
- readonly public_repos?: number;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly slug?: string;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly website_url?: unknown;
- };
- /** @enum {string} */
- readonly action: "renamed";
- readonly changes: {
- readonly login?: {
- readonly from: string;
- };
- readonly slug?: {
- readonly from: string;
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- readonly target_type: string;
- };
- /** installation unsuspend event */
- readonly "webhook-installation-unsuspend": {
- /** @enum {string} */
- readonly action: "unsuspend";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects that the installation can access. */
- readonly repositories?: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly requester?: unknown;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issue_comment created event */
- readonly "webhook-issue-comment-created": {
- /** @enum {string} */
- readonly action: "created";
- /**
- * issue comment
- * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
- */
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue comment */
- readonly body: string;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- /**
- * Format: int64
- * @description Unique identifier of the issue comment
- */
- readonly id: number;
- /** Format: uri */
- readonly issue_url: string;
- readonly node_id: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue comment
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: string | null;
- /** User */
- readonly assignee: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- readonly labels_url?: string;
- readonly locked: boolean;
- readonly milestone?: Record;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state: "open" | "closed";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issue_comment deleted event */
- readonly "webhook-issue-comment-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- /**
- * issue comment
- * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
- */
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue comment */
- readonly body: string;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- /**
- * Format: int64
- * @description Unique identifier of the issue comment
- */
- readonly id: number;
- /** Format: uri */
- readonly issue_url: string;
- readonly node_id: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue comment
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: string | null;
- /** User */
- readonly assignee: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- readonly labels_url?: string;
- readonly locked: boolean;
- readonly milestone?: Record;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state: "open" | "closed";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issue_comment edited event */
- readonly "webhook-issue-comment-edited": {
- /** @enum {string} */
- readonly action: "edited";
- /** @description The changes to the comment. */
- readonly changes: {
- readonly body?: {
- /** @description The previous version of the body. */
- readonly from: string;
- };
- };
- /**
- * issue comment
- * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
- */
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue comment */
- readonly body: string;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- /**
- * Format: int64
- * @description Unique identifier of the issue comment
- */
- readonly id: number;
- /** Format: uri */
- readonly issue_url: string;
- readonly node_id: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue comment
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: string | null;
- /** User */
- readonly assignee: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- readonly labels_url?: string;
- readonly locked: boolean;
- readonly milestone?: Record;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state: "open" | "closed";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues assigned event */
- readonly "webhook-issues-assigned": {
- /**
- * @description The action that was performed.
- * @enum {string}
- */
- readonly action: "assigned";
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues closed event */
- readonly "webhook-issues-closed": {
- /**
- * @description The action that was performed.
- * @enum {string}
- */
- readonly action: "closed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: string | null;
- readonly assignee?: Record;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels?: Record[];
- readonly labels_url?: string;
- readonly locked?: boolean;
- readonly milestone?: Record;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- /** @enum {string} */
- readonly state: "closed" | "open";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues deleted event */
- readonly "webhook-issues-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues demilestoned event */
- readonly "webhook-issues-demilestoned": {
- /** @enum {string} */
- readonly action: "demilestoned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: string | null;
- readonly assignee?: Record;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels?: Record[];
- readonly labels_url?: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- readonly state?: string;
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
+ readonly "nullable-repository-webhooks": {
/**
- * Milestone
- * @description A collection of related issues and pull requests.
+ * @description Unique identifier of the repository
+ * @example 42
*/
- readonly milestone?: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
+ readonly id: number;
+ /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ readonly node_id: string;
+ /**
+ * @description The name of the repository.
+ * @example Team Environment
+ */
+ readonly name: string;
+ /** @example octocat/Hello-World */
+ readonly full_name: string;
+ readonly license: components["schemas"]["nullable-license-simple"];
+ readonly organization?: components["schemas"]["nullable-simple-user"];
+ readonly forks: number;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly pull: boolean;
+ readonly triage?: boolean;
+ readonly push: boolean;
+ readonly maintain?: boolean;
};
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues edited event */
- readonly "webhook-issues-edited": {
- /** @enum {string} */
- readonly action: "edited";
- /** @description The changes to the issue. */
- readonly changes: {
- readonly body?: {
- /** @description The previous version of the body. */
- readonly from: string;
- };
- readonly title?: {
- /** @description The previous version of the title. */
- readonly from: string;
- };
+ readonly owner: components["schemas"]["simple-user"];
+ /**
+ * @description Whether the repository is private or public.
+ * @default false
+ */
+ readonly private: boolean;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World
+ */
+ readonly html_url: string;
+ /** @example This your first repo! */
+ readonly description: string | null;
+ readonly fork: boolean;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World
+ */
+ readonly url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
+ readonly archive_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
+ readonly assignees_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
+ readonly blobs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
+ readonly branches_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
+ readonly collaborators_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
+ readonly comments_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
+ readonly commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
+ readonly compare_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
+ readonly contents_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/contributors
+ */
+ readonly contributors_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/deployments
+ */
+ readonly deployments_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/downloads
+ */
+ readonly downloads_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/events
+ */
+ readonly events_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/forks
+ */
+ readonly forks_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
+ readonly git_commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
+ readonly git_refs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
+ readonly git_tags_url: string;
+ /** @example git:github.com/octocat/Hello-World.git */
+ readonly git_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
+ readonly issue_comment_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
+ readonly issue_events_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
+ readonly issues_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
+ readonly keys_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
+ readonly labels_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/languages
+ */
+ readonly languages_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/merges
+ */
+ readonly merges_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
+ readonly milestones_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
+ readonly notifications_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
+ readonly pulls_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
+ readonly releases_url: string;
+ /** @example git@github.com:octocat/Hello-World.git */
+ readonly ssh_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/stargazers
+ */
+ readonly stargazers_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
+ readonly statuses_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscribers
+ */
+ readonly subscribers_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscription
+ */
+ readonly subscription_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/tags
+ */
+ readonly tags_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/teams
+ */
+ readonly teams_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
+ readonly trees_url: string;
+ /** @example https://github.com/octocat/Hello-World.git */
+ readonly clone_url: string;
+ /**
+ * Format: uri
+ * @example git:git.example.com/octocat/Hello-World
+ */
+ readonly mirror_url: string | null;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/hooks
+ */
+ readonly hooks_url: string;
+ /**
+ * Format: uri
+ * @example https://svn.github.com/octocat/Hello-World
+ */
+ readonly svn_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com
+ */
+ readonly homepage: string | null;
+ readonly language: string | null;
+ /** @example 9 */
+ readonly forks_count: number;
+ /** @example 80 */
+ readonly stargazers_count: number;
+ /** @example 80 */
+ readonly watchers_count: number;
+ /**
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @example 108
+ */
+ readonly size: number;
+ /**
+ * @description The default branch of the repository.
+ * @example master
+ */
+ readonly default_branch: string;
+ /** @example 0 */
+ readonly open_issues_count: number;
+ /**
+ * @description Whether this repository acts as a template that can be used to generate new repositories.
+ * @default false
+ * @example true
+ */
+ readonly is_template: boolean;
+ readonly topics?: string[];
+ /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
+ readonly custom_properties?: {
+ readonly [key: string]: unknown;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
/**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ * @description Whether issues are enabled.
+ * @default true
+ * @example true
*/
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
+ readonly has_issues: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ * @example true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ * @example true
+ */
+ readonly has_wiki: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ * @example true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ * @example true
+ */
+ readonly has_discussions: boolean;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
+ /** @description Returns whether or not this repository disabled. */
+ readonly disabled: boolean;
+ /**
+ * @description The repository visibility: public, private, or internal.
+ * @default public
+ */
+ readonly visibility: string;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
+ */
+ readonly pushed_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
+ */
+ readonly created_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:14:43Z
+ */
+ readonly updated_at: string | null;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ * @example true
+ */
+ readonly allow_rebase_merge: boolean;
+ readonly template_repository?: {
+ readonly id?: number;
+ readonly node_id?: string;
+ readonly name?: string;
+ readonly full_name?: string;
+ readonly owner?: {
+ readonly login?: string;
+ readonly id?: number;
+ readonly node_id?: string;
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
+ readonly html_url?: string;
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
+ readonly events_url?: string;
+ readonly received_events_url?: string;
+ readonly type?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
+ };
+ readonly private?: boolean;
+ readonly html_url?: string;
+ readonly description?: string;
+ readonly fork?: boolean;
+ readonly url?: string;
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly forks_url?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly git_url?: string;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly notifications_url?: string;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly ssh_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly clone_url?: string;
+ readonly mirror_url?: string;
+ readonly hooks_url?: string;
+ readonly svn_url?: string;
+ readonly homepage?: string;
+ readonly language?: string;
+ readonly forks_count?: number;
+ readonly stargazers_count?: number;
+ readonly watchers_count?: number;
+ readonly size?: number;
+ readonly default_branch?: string;
+ readonly open_issues_count?: number;
+ readonly is_template?: boolean;
+ readonly topics?: string[];
+ readonly has_issues?: boolean;
+ readonly has_projects?: boolean;
+ readonly has_wiki?: boolean;
+ readonly has_pages?: boolean;
+ readonly has_downloads?: boolean;
+ readonly archived?: boolean;
+ readonly disabled?: boolean;
+ readonly visibility?: string;
+ readonly pushed_at?: string;
+ readonly created_at?: string;
+ readonly updated_at?: string;
+ readonly permissions?: {
+ readonly admin?: boolean;
+ readonly maintain?: boolean;
+ readonly push?: boolean;
+ readonly triage?: boolean;
+ readonly pull?: boolean;
+ };
+ readonly allow_rebase_merge?: boolean;
+ readonly temp_clone_token?: string;
+ readonly allow_squash_merge?: boolean;
+ readonly allow_auto_merge?: boolean;
+ readonly delete_branch_on_merge?: boolean;
+ readonly allow_update_branch?: boolean;
+ readonly use_squash_pr_title_as_default?: boolean;
/**
- * AuthorAssociation
- * @description How the author is associated with the repository.
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
*/
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
- * @description State of the issue; either 'open' or 'closed'
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
- * Format: uri
- * @description URL for the issue
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
*/
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- /** Label */
- readonly label?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ readonly allow_merge_commit?: boolean;
+ readonly subscribers_count?: number;
+ readonly network_count?: number;
+ } | null;
+ readonly temp_clone_token?: string;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ * @example true
+ */
+ readonly allow_squash_merge: boolean;
+ /**
+ * @description Whether to allow Auto-merge to be used on pull requests.
+ * @default false
+ * @example false
+ */
+ readonly allow_auto_merge: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ * @example false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /**
+ * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
+ * @default false
+ * @example false
+ */
+ readonly allow_update_branch: boolean;
+ /**
+ * @deprecated
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ * @example true
+ */
+ readonly allow_merge_commit: boolean;
+ /** @description Whether to allow forking this repo */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to require contributors to sign off on web-based commits
+ * @default false
+ */
+ readonly web_commit_signoff_required: boolean;
+ readonly subscribers_count?: number;
+ readonly network_count?: number;
+ readonly open_issues: number;
+ readonly watchers: number;
+ readonly master_branch?: string;
+ /** @example "2020-07-09T00:17:42Z" */
+ readonly starred_at?: string;
+ /** @description Whether anonymous git access is enabled for this repository */
+ readonly anonymous_access_enabled?: boolean;
+ } | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly webhooks_milestone_3: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues labeled event */
- readonly "webhook-issues-labeled": {
- /** @enum {string} */
- readonly action: "labeled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
/**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ * @description The state of the milestone.
+ * @enum {string}
*/
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /**
+ * Membership
+ * @description The membership between the user and the organization. Not present when the action is `member_invited`.
+ */
+ readonly webhooks_membership: {
+ /** Format: uri */
+ readonly organization_url: string;
+ readonly role: string;
+ readonly state: string;
+ /** Format: uri */
+ readonly url: string;
+ /** User */
+ readonly user: {
/** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
/** Format: uri */
- readonly events_url: string;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
+ readonly html_url?: string;
readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
+ readonly starred_url?: string;
/** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
+ readonly url?: string;
+ } | null;
+ };
+ /**
+ * Personal Access Token Request
+ * @description Details of a Personal Access Token Request.
+ */
+ readonly "personal-access-token-request": {
+ /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */
+ readonly id: number;
+ readonly owner: components["schemas"]["simple-user"];
+ /** @description New requested permissions, categorized by type of permission. */
+ readonly permissions_added: {
+ readonly organization?: {
+ readonly [key: string]: string | undefined;
+ };
+ readonly repository?: {
+ readonly [key: string]: string | undefined;
+ };
+ readonly other?: {
+ readonly [key: string]: string | undefined;
+ };
};
- /** Label */
- readonly label?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
+ /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */
+ readonly permissions_upgraded: {
+ readonly organization?: {
+ readonly [key: string]: string | undefined;
+ };
+ readonly repository?: {
+ readonly [key: string]: string | undefined;
+ };
+ readonly other?: {
+ readonly [key: string]: string | undefined;
+ };
+ };
+ /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */
+ readonly permissions_result: {
+ readonly organization?: {
+ readonly [key: string]: string | undefined;
+ };
+ readonly repository?: {
+ readonly [key: string]: string | undefined;
+ };
+ readonly other?: {
+ readonly [key: string]: string | undefined;
+ };
+ };
+ /**
+ * @description Type of repository selection requested.
+ * @enum {string}
+ */
+ readonly repository_selection: "none" | "all" | "subset";
+ /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */
+ readonly repository_count: number | null;
+ /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */
+ readonly repositories: {
+ readonly full_name: string;
+ /** @description Unique identifier of the repository */
readonly id: number;
- /** @description The name of the label. */
+ /** @description The name of the repository. */
readonly name: string;
readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ }[] | null;
+ /** @description Date and time when the request for access was created. */
+ readonly created_at: string;
+ /** @description Whether the associated fine-grained personal access token has expired. */
+ readonly token_expired: boolean;
+ /** @description Date and time when the associated fine-grained personal access token expires. */
+ readonly token_expires_at: string | null;
+ /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */
+ readonly token_last_used_at: string | null;
};
- /** issues locked event */
- readonly "webhook-issues-locked": {
- /** @enum {string} */
- readonly action: "locked";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ /** Project Card */
+ readonly webhooks_project_card: {
+ readonly after_id?: number | null;
+ /** @description Whether or not the card is archived */
+ readonly archived: boolean;
+ readonly column_id: number;
+ /** Format: uri */
+ readonly column_url: string;
+ /** Format: uri */
+ readonly content_url?: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
/** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
/** Format: uri */
- readonly events_url: string;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
+ readonly html_url?: string;
readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The project card's ID */
+ readonly id: number;
+ readonly node_id: string;
+ readonly note: string | null;
+ /** Format: uri */
+ readonly project_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Project */
+ readonly webhooks_project: {
+ /** @description Body of the project */
+ readonly body: string | null;
+ /** Format: uri */
+ readonly columns_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
/** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
+ readonly url?: string;
+ } | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** @description Name of the project */
+ readonly name: string;
+ readonly node_id: string;
+ readonly number: number;
+ /** Format: uri */
+ readonly owner_url: string;
+ /**
+ * @description State of the project; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Project Column */
+ readonly webhooks_project_column: {
+ readonly after_id?: number | null;
+ /** Format: uri */
+ readonly cards_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** @description The unique identifier of the project column */
+ readonly id: number;
+ /** @description Name of the project column */
+ readonly name: string;
+ readonly node_id: string;
+ /** Format: uri */
+ readonly project_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /**
+ * Projects v2 Project
+ * @description A projects v2 project
+ */
+ readonly "projects-v2": {
+ readonly id: number;
+ readonly node_id: string;
+ readonly owner: components["schemas"]["simple-user"];
+ readonly creator: components["schemas"]["simple-user"];
+ readonly title: string;
+ readonly description: string | null;
+ readonly public: boolean;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly closed_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly updated_at: string;
+ readonly number: number;
+ readonly short_description: string | null;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly deleted_at: string | null;
+ readonly deleted_by: components["schemas"]["nullable-simple-user"];
+ };
+ readonly webhooks_project_changes: {
+ readonly archived_at?: {
/** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ readonly from?: string | null;
+ /** Format: date-time */
+ readonly to?: string | null;
+ };
+ };
+ /**
+ * Projects v2 Item Content Type
+ * @description The type of content tracked in a project item
+ * @enum {string}
+ */
+ readonly "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue";
+ /**
+ * Projects v2 Item
+ * @description An item belonging to a project
+ */
+ readonly "projects-v2-item": {
+ readonly id: number;
+ readonly node_id?: string;
+ readonly project_node_id?: string;
+ readonly content_node_id: string;
+ readonly content_type: components["schemas"]["projects-v2-item-content-type"];
+ readonly creator?: components["schemas"]["simple-user"];
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly updated_at: string;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly archived_at: string | null;
+ };
+ /** @description The pull request number. */
+ readonly webhooks_number: number;
+ readonly "pull-request-webhook": components["schemas"]["pull-request"] & {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow updating the pull request's branch. */
+ readonly allow_update_branch?: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged.
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /**
+ * @description The default value for a merge commit message.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name").
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a squash merge commit message:
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
+ };
+ /** Pull Request */
+ readonly webhooks_pull_request_5: {
+ readonly _links: {
+ /** Link */
+ readonly comments: {
/** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
+ readonly href: string;
+ };
+ /** Link */
+ readonly commits: {
/** Format: uri-template */
- readonly following_url?: string;
+ readonly href: string;
+ };
+ /** Link */
+ readonly html: {
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ readonly href: string;
+ };
+ /** Link */
+ readonly issue: {
/** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly assignee?: Record;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comment: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comments: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly self: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly statuses: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ };
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly additions?: number;
+ /** User */
+ readonly assignee: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
readonly html_url?: string;
- readonly id?: number;
- readonly labels?: Record[];
- readonly labels_url?: string;
- /** @enum {boolean} */
- readonly locked: true;
- readonly milestone?: Record;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- readonly state?: string;
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues milestoned event */
- readonly "webhook-issues-milestoned": {
- /** @enum {string} */
- readonly action: "milestoned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ } | null;
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ readonly auto_merge: {
+ /** @description Commit message for the merge commit. */
+ readonly commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ readonly commit_title: string | null;
/** User */
- readonly assignee?: {
+ readonly enabled_by: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -43769,174 +35470,189 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ readonly merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ readonly base: {
+ readonly label: string;
+ readonly ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ readonly repo: {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow private forks */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ readonly allow_rebase_merge: boolean;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ readonly allow_squash_merge: boolean;
+ readonly allow_update_branch?: boolean;
/** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
+ readonly archive_url: string;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
/** Format: uri-template */
- readonly following_url?: string;
+ readonly assignees_url: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ readonly blobs_url: string;
+ /** Format: uri-template */
+ readonly branches_url: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ readonly clone_url: string;
+ /** Format: uri-template */
+ readonly collaborators_url: string;
+ /** Format: uri-template */
+ readonly comments_url: string;
+ /** Format: uri-template */
+ readonly commits_url: string;
+ /** Format: uri-template */
+ readonly compare_url: string;
+ /** Format: uri-template */
+ readonly contents_url: string;
/** Format: uri */
- readonly organizations_url?: string;
+ readonly contributors_url: string;
+ readonly created_at: number | string;
+ /** @description The default branch of the repository. */
+ readonly default_branch: string;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
/** Format: uri */
- readonly received_events_url?: string;
+ readonly deployments_url: string;
+ readonly description: string | null;
+ /** @description Returns whether or not this repository is disabled. */
+ readonly disabled?: boolean;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
+ readonly downloads_url: string;
/** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly events_url: string;
+ readonly fork: boolean;
+ readonly forks: number;
+ readonly forks_count: number;
/** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ readonly forks_url: string;
+ readonly full_name: string;
+ /** Format: uri-template */
+ readonly git_commits_url: string;
+ /** Format: uri-template */
+ readonly git_refs_url: string;
+ /** Format: uri-template */
+ readonly git_tags_url: string;
+ /** Format: uri */
+ readonly git_url: string;
/**
- * Format: uri
- * @description URL for the label
+ * @description Whether downloads are enabled.
+ * @default true
*/
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ readonly has_issues: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ readonly has_wiki: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ readonly has_discussions: boolean;
+ readonly homepage: string | null;
+ /** Format: uri */
+ readonly hooks_url: string;
/** Format: uri */
readonly html_url: string;
+ /** @description Unique identifier of the repository */
readonly id: number;
- /** Format: uri */
+ readonly is_template?: boolean;
+ /** Format: uri-template */
+ readonly issue_comment_url: string;
+ /** Format: uri-template */
+ readonly issue_events_url: string;
+ /** Format: uri-template */
+ readonly issues_url: string;
+ /** Format: uri-template */
+ readonly keys_url: string;
+ /** Format: uri-template */
readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ readonly language: string | null;
+ /** Format: uri */
+ readonly languages_url: string;
+ /** License */
+ readonly license: {
+ readonly key: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly spdx_id: string;
+ /** Format: uri */
+ readonly url: string | null;
+ } | null;
+ readonly master_branch?: string;
/**
- * @description The state of the milestone.
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[];
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly external_url: string | null;
+ readonly merges_url: string;
+ /** Format: uri-template */
+ readonly milestones_url: string;
/** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
+ readonly mirror_url: string | null;
+ /** @description The name of the repository. */
readonly name: string;
readonly node_id: string;
+ /** Format: uri-template */
+ readonly notifications_url: string;
+ readonly open_issues: number;
+ readonly open_issues_count: number;
+ readonly organization?: string;
/** User */
readonly owner: {
/** Format: uri */
@@ -43974,129 +35690,77 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- /** @description The set of permissions for the GitHub app */
readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly pull: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
};
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ readonly public?: boolean;
+ /** Format: uri-template */
+ readonly pulls_url: string;
+ readonly pushed_at: (number | string) | null;
+ /** Format: uri-template */
+ readonly releases_url: string;
+ readonly role_name?: string | null;
+ readonly size: number;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly ssh_url: string;
+ readonly stargazers?: number;
+ readonly stargazers_count: number;
/** Format: uri */
- readonly diff_url?: string;
+ readonly stargazers_url: string;
+ /** Format: uri-template */
+ readonly statuses_url: string;
/** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
+ readonly subscribers_url: string;
/** Format: uri */
- readonly patch_url?: string;
+ readonly subscription_url: string;
/** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
+ readonly svn_url: string;
+ /** Format: uri */
+ readonly tags_url: string;
+ /** Format: uri */
+ readonly teams_url: string;
+ readonly topics: string[];
+ /** Format: uri-template */
+ readonly trees_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
/** Format: uri */
readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
+ /** @enum {string} */
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
};
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
+ readonly sha: string;
/** User */
readonly user: {
/** Format: uri */
@@ -44104,64 +35768,233 @@ export type components = {
readonly deleted?: boolean;
readonly email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ readonly body: string | null;
+ readonly changed_files?: number;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments?: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ readonly commits?: number;
+ /** Format: uri */
+ readonly commits_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly deletions?: number;
+ /** Format: uri */
+ readonly diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ readonly draft: boolean;
+ readonly head: {
+ readonly label: string;
+ readonly ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ readonly repo: {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow private forks */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ readonly allow_rebase_merge: boolean;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ readonly allow_squash_merge: boolean;
+ readonly allow_update_branch?: boolean;
+ /** Format: uri-template */
+ readonly archive_url: string;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
+ /** Format: uri-template */
+ readonly assignees_url: string;
+ /** Format: uri-template */
+ readonly blobs_url: string;
+ /** Format: uri-template */
+ readonly branches_url: string;
+ /** Format: uri */
+ readonly clone_url: string;
+ /** Format: uri-template */
+ readonly collaborators_url: string;
+ /** Format: uri-template */
+ readonly comments_url: string;
+ /** Format: uri-template */
+ readonly commits_url: string;
+ /** Format: uri-template */
+ readonly compare_url: string;
+ /** Format: uri-template */
+ readonly contents_url: string;
+ /** Format: uri */
+ readonly contributors_url: string;
+ readonly created_at: number | string;
+ /** @description The default branch of the repository. */
+ readonly default_branch: string;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /** Format: uri */
+ readonly deployments_url: string;
+ readonly description: string | null;
+ /** @description Returns whether or not this repository is disabled. */
+ readonly disabled?: boolean;
+ /** Format: uri */
+ readonly downloads_url: string;
+ /** Format: uri */
+ readonly events_url: string;
+ readonly fork: boolean;
+ readonly forks: number;
+ readonly forks_count: number;
+ /** Format: uri */
+ readonly forks_url: string;
+ readonly full_name: string;
+ /** Format: uri-template */
+ readonly git_commits_url: string;
+ /** Format: uri-template */
+ readonly git_refs_url: string;
+ /** Format: uri-template */
+ readonly git_tags_url: string;
+ /** Format: uri */
+ readonly git_url: string;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ readonly has_issues: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ readonly has_wiki: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ readonly has_discussions: boolean;
+ readonly homepage: string | null;
+ /** Format: uri */
+ readonly hooks_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ readonly is_template?: boolean;
+ /** Format: uri-template */
+ readonly issue_comment_url: string;
+ /** Format: uri-template */
+ readonly issue_events_url: string;
/** Format: uri-template */
- readonly following_url?: string;
+ readonly issues_url: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
+ readonly keys_url: string;
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly language: string | null;
/** Format: uri */
- readonly received_events_url?: string;
+ readonly languages_url: string;
+ /** License */
+ readonly license: {
+ readonly key: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly spdx_id: string;
+ /** Format: uri */
+ readonly url: string | null;
+ } | null;
+ readonly master_branch?: string;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ readonly merges_url: string;
/** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly milestones_url: string;
/** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: string | null;
- readonly assignee?: Record;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels?: Record[];
- readonly labels_url?: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
+ readonly mirror_url: string | null;
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** Format: uri-template */
+ readonly notifications_url: string;
+ readonly open_issues: number;
+ readonly open_issues_count: number;
+ readonly organization?: string;
/** User */
- readonly creator: {
+ readonly owner: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -44193,76 +36026,185 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly pull: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
+ };
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ readonly public?: boolean;
+ /** Format: uri-template */
+ readonly pulls_url: string;
+ readonly pushed_at: (number | string) | null;
+ /** Format: uri-template */
+ readonly releases_url: string;
+ readonly role_name?: string | null;
+ readonly size: number;
/**
- * @description The state of the milestone.
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly ssh_url: string;
+ readonly stargazers?: number;
+ readonly stargazers_count: number;
+ /** Format: uri */
+ readonly stargazers_url: string;
+ /** Format: uri-template */
+ readonly statuses_url: string;
+ /** Format: uri */
+ readonly subscribers_url: string;
+ /** Format: uri */
+ readonly subscription_url: string;
+ /** Format: uri */
+ readonly svn_url: string;
+ /** Format: uri */
+ readonly tags_url: string;
+ /** Format: uri */
+ readonly teams_url: string;
+ readonly topics: string[];
+ /** Format: uri-template */
+ readonly trees_url: string;
/** Format: date-time */
readonly updated_at: string;
/** Format: uri */
readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
+ /** @enum {string} */
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
};
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- readonly state?: string;
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
+ readonly sha: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
readonly events_url?: string;
+ /** Format: uri */
readonly followers_url?: string;
+ /** Format: uri-template */
readonly following_url?: string;
+ /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
+ /** Format: uri */
readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
readonly node_id?: string;
+ /** Format: uri */
readonly organizations_url?: string;
+ /** Format: uri */
readonly received_events_url?: string;
+ /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
+ /** Format: uri-template */
readonly starred_url?: string;
+ /** Format: uri */
readonly subscriptions_url?: string;
- readonly type?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
readonly url?: string;
- };
+ } | null;
};
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly issue_url: string;
+ readonly labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ readonly locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ readonly maintainer_can_modify?: boolean;
+ readonly merge_commit_sha: string | null;
+ readonly mergeable?: boolean | null;
+ readonly mergeable_state?: string;
+ readonly merged?: boolean | null;
+ /** Format: date-time */
+ readonly merged_at: string | null;
+ /** User */
+ readonly merged_by?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
@@ -44333,875 +36275,1231 @@ export type components = {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues opened event */
- readonly "webhook-issues-opened": {
- /** @enum {string} */
- readonly action: "opened";
- readonly changes?: {
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly old_issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
+ } | null;
+ readonly node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ readonly number: number;
+ /** Format: uri */
+ readonly patch_url: string;
+ readonly rebaseable?: boolean | null;
+ readonly requested_reviewers: (({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null) | {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repository_url: string;
+ readonly repositories_url: string;
+ readonly slug: string;
/**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
+ * Format: uri
+ * @description URL for the team
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ readonly url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
+ /** @enum {string} */
+ readonly privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url?: string;
+ })[];
+ readonly requested_teams: {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
/** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
/**
* Format: uri
- * @description URL for the issue
+ * @description URL for the team
*/
readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
} | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
+ /** @enum {string} */
+ readonly privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
/**
- * Repository
- * @description A git repository
+ * Format: uri
+ * @description URL for the team
*/
- readonly old_repository: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ readonly url?: string;
+ }[];
+ /** Format: uri-template */
+ readonly review_comment_url: string;
+ readonly review_comments?: number;
+ /** Format: uri */
+ readonly review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** Format: uri */
+ readonly statuses_url: string;
+ /** @description The title of the pull request. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ /**
+ * Pull Request Review Comment
+ * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.
+ */
+ readonly webhooks_review_comment: {
+ readonly _links: {
+ /** Link */
+ readonly html: {
/** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
+ readonly href: string;
+ };
+ /** Link */
+ readonly pull_request: {
/** Format: uri-template */
- readonly assignees_url: string;
+ readonly href: string;
+ };
+ /** Link */
+ readonly self: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description The text of the comment. */
+ readonly body: string;
+ /** @description The SHA of the commit to which the comment applies. */
+ readonly commit_id: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** @description The diff of the line that the comment refers to. */
+ readonly diff_hunk: string;
+ /**
+ * Format: uri
+ * @description HTML URL for the pull request review comment.
+ */
+ readonly html_url: string;
+ /** @description The ID of the pull request review comment. */
+ readonly id: number;
+ /** @description The comment ID to reply to. */
+ readonly in_reply_to_id?: number;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ readonly line: number | null;
+ /** @description The node ID of the pull request review comment. */
+ readonly node_id: string;
+ /** @description The SHA of the original commit to which the comment applies. */
+ readonly original_commit_id: string;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ readonly original_line: number;
+ /** @description The index of the original line in the diff to which the comment applies. */
+ readonly original_position: number;
+ /** @description The first line of the range for a multi-line comment. */
+ readonly original_start_line: number | null;
+ /** @description The relative path of the file to which the comment applies. */
+ readonly path: string;
+ /** @description The line index in the diff to which the comment applies. */
+ readonly position: number | null;
+ /** @description The ID of the pull request review to which the comment belongs. */
+ readonly pull_request_review_id: number | null;
+ /**
+ * Format: uri
+ * @description URL for the pull request that the review comment belongs to.
+ */
+ readonly pull_request_url: string;
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @enum {string}
+ */
+ readonly side: "LEFT" | "RIGHT";
+ /** @description The first line of the range for a multi-line comment. */
+ readonly start_line: number | null;
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @default RIGHT
+ * @enum {string|null}
+ */
+ readonly start_side: "LEFT" | "RIGHT" | null;
+ /**
+ * @description The level at which the comment is targeted, can be a diff line or a file.
+ * @enum {string}
+ */
+ readonly subject_type?: "line" | "file";
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the pull request review comment
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ /** @description The review that was affected. */
+ readonly webhooks_review: {
+ readonly _links: {
+ /** Link */
+ readonly html: {
/** Format: uri-template */
- readonly blobs_url: string;
+ readonly href: string;
+ };
+ /** Link */
+ readonly pull_request: {
/** Format: uri-template */
- readonly branches_url: string;
+ readonly href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description The text of the review. */
+ readonly body: string | null;
+ /** @description A commit SHA for the review. */
+ readonly commit_id: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the review */
+ readonly id: number;
+ readonly node_id: string;
+ /** Format: uri */
+ readonly pull_request_url: string;
+ readonly state: string;
+ /** Format: date-time */
+ readonly submitted_at: string | null;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ readonly webhooks_nullable_string: string | null;
+ /**
+ * Release
+ * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
+ */
+ readonly webhooks_release: {
+ readonly assets: {
+ /** Format: uri */
+ readonly browser_download_url: string;
+ readonly content_type: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly download_count: number;
+ readonly id: number;
+ readonly label: string | null;
+ /** @description The file name of the asset. */
+ readonly name: string;
+ readonly node_id: string;
+ readonly size: number;
+ /**
+ * @description State of the release asset.
+ * @enum {string}
+ */
+ readonly state: "uploaded";
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** User */
+ readonly uploader?: {
/** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly commits_url: string;
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
/** Format: uri-template */
- readonly compare_url: string;
+ readonly following_url?: string;
/** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
- };
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly downloads_url: string;
+ readonly organizations_url?: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ readonly received_events_url?: string;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly git_tags_url: string;
- /** Format: uri */
- readonly git_url: string;
- /** @description Whether the repository has discussions enabled. */
- readonly has_discussions?: boolean;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
- readonly homepage: string | null;
- /** Format: uri */
- readonly hooks_url: string;
+ readonly starred_url?: string;
/** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
- /** Format: uri-template */
- readonly issues_url: string;
- /** Format: uri-template */
- readonly keys_url: string;
- /** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
+ readonly url?: string;
+ } | null;
+ /** Format: uri */
+ readonly url: string;
+ }[];
+ /** Format: uri */
+ readonly assets_url: string;
+ /** User */
+ readonly author: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly created_at: string | null;
+ /** Format: uri */
+ readonly discussion_url?: string;
+ /** @description Whether the release is a draft or published */
+ readonly draft: boolean;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string | null;
+ readonly node_id: string;
+ /** @description Whether the release is identified as a prerelease or a full release. */
+ readonly prerelease: boolean;
+ /** Format: date-time */
+ readonly published_at: string | null;
+ /** Reactions */
+ readonly reactions?: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** @description The name of the tag. */
+ readonly tag_name: string;
+ /** Format: uri */
+ readonly tarball_url: string | null;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. */
+ readonly target_commitish: string;
+ /** Format: uri-template */
+ readonly upload_url: string;
+ /** Format: uri */
+ readonly url: string;
+ /** Format: uri */
+ readonly zipball_url: string | null;
+ };
+ /**
+ * Release
+ * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
+ */
+ readonly webhooks_release_1: {
+ readonly assets: ({
+ /** Format: uri */
+ readonly browser_download_url: string;
+ readonly content_type: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly download_count: number;
+ readonly id: number;
+ readonly label: string | null;
+ /** @description The file name of the asset. */
+ readonly name: string;
+ readonly node_id: string;
+ readonly size: number;
+ /**
+ * @description State of the release asset.
+ * @enum {string}
+ */
+ readonly state: "uploaded";
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** User */
+ readonly uploader?: {
/** Format: uri */
- readonly merges_url: string;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly milestones_url: string;
+ readonly events_url?: string;
/** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- };
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ readonly followers_url?: string;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
+ readonly following_url?: string;
/** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly subscription_url: string;
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly svn_url: string;
+ readonly organizations_url?: string;
/** Format: uri */
- readonly tags_url: string;
+ readonly received_events_url?: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly starred_url?: string;
/** Format: uri */
- readonly url: string;
+ readonly subscriptions_url?: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require commit signoff. */
- readonly web_commit_signoff_required?: boolean;
- };
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** Format: uri */
+ readonly url: string;
+ } | null)[];
+ /** Format: uri */
+ readonly assets_url: string;
+ /** User */
+ readonly author: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly created_at: string | null;
+ /** Format: uri */
+ readonly discussion_url?: string;
+ /** @description Whether the release is a draft or published */
+ readonly draft: boolean;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string | null;
+ readonly node_id: string;
+ /** @description Whether the release is identified as a prerelease or a full release. */
+ readonly prerelease: boolean;
+ /** Format: date-time */
+ readonly published_at: string | null;
+ /** Reactions */
+ readonly reactions?: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ /** @description The name of the tag. */
+ readonly tag_name: string;
+ /** Format: uri */
+ readonly tarball_url: string | null;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. */
+ readonly target_commitish: string;
+ /** Format: uri-template */
+ readonly upload_url: string;
+ /** Format: uri */
+ readonly url: string;
+ /** Format: uri */
+ readonly zipball_url: string | null;
+ };
+ /**
+ * Repository Vulnerability Alert Alert
+ * @description The security alert of the vulnerable dependency.
+ */
+ readonly webhooks_alert: {
+ readonly affected_package_name: string;
+ readonly affected_range: string;
+ readonly created_at: string;
+ readonly dismiss_reason?: string;
+ readonly dismissed_at?: string;
+ /** User */
+ readonly dismisser?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly external_identifier: string;
+ /** Format: uri */
+ readonly external_reference: string | null;
+ readonly fix_reason?: string;
+ /** Format: date-time */
+ readonly fixed_at?: string;
+ readonly fixed_in?: string;
+ readonly ghsa_id: string;
+ readonly id: number;
+ readonly node_id: string;
+ readonly number: number;
+ readonly severity: string;
+ /** @enum {string} */
+ readonly state: "open";
+ };
+ /**
+ * @description The reason for resolving the alert.
+ * @enum {string|null}
+ */
+ readonly "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited";
+ readonly "secret-scanning-alert-webhook": {
+ readonly number?: components["schemas"]["alert-number"];
+ readonly created_at?: components["schemas"]["alert-created-at"];
+ readonly updated_at?: components["schemas"]["nullable-alert-updated-at"];
+ readonly url?: components["schemas"]["alert-url"];
+ readonly html_url?: components["schemas"]["alert-html-url"];
/**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ * Format: uri
+ * @description The REST API URL of the code locations for this alert.
*/
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
+ readonly locations_url?: string;
+ readonly resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"];
+ /**
+ * Format: date-time
+ * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ readonly resolved_at?: string | null;
+ readonly resolved_by?: components["schemas"]["nullable-simple-user"];
+ /** @description An optional comment to resolve an alert. */
+ readonly resolution_comment?: string | null;
+ /** @description The type of secret that secret scanning detected. */
+ readonly secret_type?: string;
+ /**
+ * @description The token status as of the latest validity check.
+ * @enum {string}
+ */
+ readonly validity?: "active" | "inactive" | "unknown";
+ /** @description Whether push protection was bypassed for the detected secret. */
+ readonly push_protection_bypassed?: boolean | null;
+ readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"];
+ /**
+ * Format: date-time
+ * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ readonly push_protection_bypassed_at?: string | null;
+ };
+ /** @description The details of the security advisory, including summary, description, and severity. */
+ readonly webhooks_security_advisory: {
+ readonly cvss: {
+ readonly score: number;
+ readonly vector_string: string | null;
+ };
+ readonly cwes: {
+ readonly cwe_id: string;
+ readonly name: string;
+ }[];
+ readonly description: string;
+ readonly ghsa_id: string;
+ readonly identifiers: {
+ readonly type: string;
+ readonly value: string;
+ }[];
+ readonly published_at: string;
+ readonly references: {
+ /** Format: uri */
+ readonly url: string;
+ }[];
+ readonly severity: string;
+ readonly summary: string;
+ readonly updated_at: string;
+ readonly vulnerabilities: {
+ readonly first_patched_version: {
+ readonly identifier: string;
} | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ readonly package: {
+ readonly ecosystem: string;
+ readonly name: string;
+ };
+ readonly severity: string;
+ readonly vulnerable_version_range: string;
+ }[];
+ readonly withdrawn_at: string | null;
+ };
+ readonly webhooks_sponsorship: {
+ readonly created_at: string;
+ readonly maintainer?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
+ readonly node_id: string;
+ readonly privacy_level: string;
+ /** User */
+ readonly sponsor: {
/** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
/** Format: uri */
- readonly events_url: string;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
+ readonly html_url?: string;
readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** User */
+ readonly sponsorable: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /**
+ * Sponsorship Tier
+ * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
+ */
+ readonly tier: {
+ readonly created_at: string;
+ readonly description: string;
+ readonly is_custom_ammount?: boolean;
+ readonly is_custom_amount?: boolean;
+ readonly is_one_time: boolean;
+ readonly monthly_price_in_cents: number;
+ readonly monthly_price_in_dollars: number;
+ readonly name: string;
+ readonly node_id: string;
+ };
+ };
+ /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */
+ readonly webhooks_effective_date: string;
+ readonly webhooks_changes_8: {
+ readonly tier: {
/**
- * Milestone
- * @description A collection of related issues and pull requests.
+ * Sponsorship Tier
+ * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
*/
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
+ readonly from: {
readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
+ readonly description: string;
+ readonly is_custom_ammount?: boolean;
+ readonly is_custom_amount?: boolean;
+ readonly is_one_time: boolean;
+ readonly monthly_price_in_cents: number;
+ readonly monthly_price_in_dollars: number;
+ readonly name: string;
readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
+ };
+ };
+ };
+ /**
+ * Team
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ readonly webhooks_team_1: {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
readonly node_id: string;
- readonly number: number;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ readonly notification_setting: "notifications_enabled" | "notifications_disabled";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
+ /** @enum {string} */
+ readonly privacy?: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
+ /** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url?: string;
+ };
+ /** branch protection configuration disabled event */
+ readonly "webhook-branch-protection-configuration-disabled": {
+ /** @enum {string} */
+ readonly action: "disabled";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** branch protection configuration enabled event */
+ readonly "webhook-branch-protection-configuration-enabled": {
+ /** @enum {string} */
+ readonly action: "enabled";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** branch protection rule created event */
+ readonly "webhook-branch-protection-rule-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly rule: components["schemas"]["webhooks_rule"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** branch protection rule deleted event */
+ readonly "webhook-branch-protection-rule-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly rule: components["schemas"]["webhooks_rule"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** branch protection rule edited event */
+ readonly "webhook-branch-protection-rule-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ /** @description If the action was `edited`, the changes to the rule. */
+ readonly changes?: {
+ readonly admin_enforced?: {
+ readonly from: boolean | null;
+ };
+ readonly authorized_actor_names?: {
+ readonly from: string[];
+ };
+ readonly authorized_actors_only?: {
+ readonly from: boolean | null;
+ };
+ readonly authorized_dismissal_actors_only?: {
+ readonly from: boolean | null;
+ };
+ readonly linear_history_requirement_enforcement_level?: {
+ /** @enum {string} */
+ readonly from: "off" | "non_admins" | "everyone";
+ };
+ readonly required_status_checks?: {
+ readonly from: string[];
+ };
+ readonly required_status_checks_enforcement_level?: {
+ /** @enum {string} */
+ readonly from: "off" | "non_admins" | "everyone";
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly rule: components["schemas"]["webhooks_rule"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Check Run Completed Event */
+ readonly "webhook-check-run-completed": {
+ /** @enum {string} */
+ readonly action?: "completed";
+ readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * Check Run Completed Event
+ * @description The check_run.completed webhook encoded with URL encoding
+ */
+ readonly "webhook-check-run-completed-form-encoded": {
+ /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */
+ readonly payload: string;
+ };
+ /** Check Run Created Event */
+ readonly "webhook-check-run-created": {
+ /** @enum {string} */
+ readonly action?: "created";
+ readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * Check Run Created Event
+ * @description The check_run.created webhook encoded with URL encoding
+ */
+ readonly "webhook-check-run-created-form-encoded": {
+ /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */
+ readonly payload: string;
+ };
+ /** Check Run Requested Action Event */
+ readonly "webhook-check-run-requested-action": {
+ /** @enum {string} */
+ readonly action: "requested_action";
+ readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ /** @description The action requested by the user. */
+ readonly requested_action?: {
+ /** @description The integrator reference of the action requested by the user. */
+ readonly identifier?: string;
+ };
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * Check Run Requested Action Event
+ * @description The check_run.requested_action webhook encoded with URL encoding
+ */
+ readonly "webhook-check-run-requested-action-form-encoded": {
+ /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */
+ readonly payload: string;
+ };
+ /** Check Run Re-Requested Event */
+ readonly "webhook-check-run-rerequested": {
+ /** @enum {string} */
+ readonly action?: "rerequested";
+ readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * Check Run Re-Requested Event
+ * @description The check_run.rerequested webhook encoded with URL encoding
+ */
+ readonly "webhook-check-run-rerequested-form-encoded": {
+ /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */
+ readonly payload: string;
+ };
+ /** check_suite completed event */
+ readonly "webhook-check-suite-completed": {
+ /** @enum {string} */
+ readonly action: "completed";
+ /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
+ readonly check_suite: {
+ readonly after: string | null;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ readonly app: {
/** Format: date-time */
readonly created_at: string | null;
readonly description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[];
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[];
/** Format: uri */
readonly external_url: string | null;
/** Format: uri */
@@ -45301,7 +37599,7 @@ export type components = {
/** @enum {string} */
readonly repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ readonly repository_projects?: "read" | "write" | "admin";
/** @enum {string} */
readonly secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
@@ -45325,232 +37623,135 @@ export type components = {
readonly slug?: string;
/** Format: date-time */
readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
};
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
+ readonly before: string | null;
+ /** Format: uri */
+ readonly check_runs_url: string;
+ /**
+ * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.
+ * @enum {string|null}
+ */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure";
+ /** Format: date-time */
+ readonly created_at: string;
+ /** @description The head branch name the changes are on. */
+ readonly head_branch: string | null;
+ /** SimpleCommit */
+ readonly head_commit: {
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly author: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly committer: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ readonly id: string;
+ readonly message: string;
+ readonly timestamp: string;
+ readonly tree_id: string;
+ };
+ /** @description The SHA of the head commit that is being checked. */
+ readonly head_sha: string;
+ readonly id: number;
+ readonly latest_check_runs_count: number;
+ readonly node_id: string;
+ /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly id: number;
+ readonly number: number;
/** Format: uri */
readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
+ }[];
+ readonly rerequestable?: boolean;
+ readonly runs_rerequestable?: boolean;
/**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
+ * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
+ * @enum {string|null}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | null | "pending";
/** Format: date-time */
readonly updated_at: string;
/**
* Format: uri
- * @description URL for the issue
+ * @description URL that points to the check suite API resource.
*/
readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
};
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** issues pinned event */
- readonly "webhook-issues-pinned": {
+ /** check_suite requested event */
+ readonly "webhook-check-suite-requested": {
/** @enum {string} */
- readonly action: "pinned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
+ readonly action: "requested";
+ /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
+ readonly check_suite: {
+ readonly after: string | null;
/**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
+ readonly app: {
+ /** Format: date-time */
+ readonly created_at: string | null;
readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
readonly name: string;
readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
/** User */
- readonly creator: {
+ readonly owner: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -45586,42 +37787,201 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- readonly description: string | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
/** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
+ readonly updated_at: string | null;
+ };
+ readonly before: string | null;
+ /** Format: uri */
+ readonly check_runs_url: string;
+ /**
+ * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.
+ * @enum {string|null}
+ */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped";
+ /** Format: date-time */
+ readonly created_at: string;
+ /** @description The head branch name the changes are on. */
+ readonly head_branch: string | null;
+ /** SimpleCommit */
+ readonly head_commit: {
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly author: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly committer: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ readonly id: string;
+ readonly message: string;
+ readonly timestamp: string;
+ readonly tree_id: string;
+ };
+ /** @description The SHA of the head commit that is being checked. */
+ readonly head_sha: string;
+ readonly id: number;
+ readonly latest_check_runs_count: number;
+ readonly node_id: string;
+ /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
/** Format: uri */
readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
+ }[];
+ readonly rerequestable?: boolean;
+ readonly runs_rerequestable?: boolean;
+ /**
+ * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
+ * @enum {string|null}
+ */
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | null;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL that points to the check suite API resource.
+ */
+ readonly url: string;
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** check_suite rerequested event */
+ readonly "webhook-check-suite-rerequested": {
+ /** @enum {string} */
+ readonly action: "rerequested";
+ /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
+ readonly check_suite: {
+ readonly after: string | null;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ readonly app: {
/** Format: date-time */
readonly created_at: string | null;
readonly description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[];
/** Format: uri */
readonly external_url: string | null;
/** Format: uri */
@@ -45705,7 +38065,7 @@ export type components = {
/** @enum {string} */
readonly organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write";
+ readonly organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
readonly organization_secrets?: "read" | "write";
/** @enum {string} */
@@ -45721,7 +38081,7 @@ export type components = {
/** @enum {string} */
readonly repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ readonly repository_projects?: "read" | "write" | "admin";
/** @enum {string} */
readonly secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
@@ -45745,54 +38105,125 @@ export type components = {
readonly slug?: string;
/** Format: date-time */
readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
};
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
+ readonly before: string | null;
+ /** Format: uri */
+ readonly check_runs_url: string;
+ /**
+ * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.
+ * @enum {string|null}
+ */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** @description The head branch name the changes are on. */
+ readonly head_branch: string | null;
+ /** SimpleCommit */
+ readonly head_commit: {
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly author: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly committer: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ readonly id: string;
+ readonly message: string;
+ readonly timestamp: string;
+ readonly tree_id: string;
+ };
+ /** @description The SHA of the head commit that is being checked. */
+ readonly head_sha: string;
+ readonly id: number;
+ readonly latest_check_runs_count: number;
+ readonly node_id: string;
+ /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly id: number;
+ readonly number: number;
/** Format: uri */
readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
+ }[];
+ readonly rerequestable?: boolean;
+ readonly runs_rerequestable?: boolean;
/**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
+ * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
+ * @enum {string|null}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | null;
/** Format: date-time */
readonly updated_at: string;
/**
* Format: uri
- * @description URL for the issue
+ * @description URL that points to the check suite API resource.
*/
readonly url: string;
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert appeared_in_branch event */
+ readonly "webhook-code-scanning-alert-appeared-in-branch": {
+ /** @enum {string} */
+ readonly action: "appeared_in_branch";
+ /** @description The code scanning alert involved in the event. */
+ readonly alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ readonly dismissed_at: string | null;
/** User */
- readonly user: {
+ readonly dismissed_by: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -45828,22 +38259,97 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
+ /**
+ * @description The reason for dismissing or closing the alert.
+ * @enum {string|null}
+ */
+ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ readonly html_url: string;
+ /** Alert Instance */
+ readonly most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ readonly analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ readonly category?: string;
+ readonly classifications?: string[];
+ readonly commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ readonly environment: string;
+ readonly location?: {
+ readonly end_column?: number;
+ readonly end_line?: number;
+ readonly path?: string;
+ readonly start_column?: number;
+ readonly start_line?: number;
+ };
+ readonly message?: {
+ readonly text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ readonly ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ readonly number: number;
+ readonly rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description: string;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity: "none" | "note" | "warning" | "error" | null;
+ };
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "open" | "dismissed" | "fixed";
+ readonly tool: {
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ readonly name: string;
+ /** @description The version of the tool used to detect the alert. */
+ readonly version: string | null;
+ };
+ /** Format: uri */
+ readonly url: string;
};
+ readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** issues reopened event */
- readonly "webhook-issues-reopened": {
+ /** code_scanning_alert closed_by_user event */
+ readonly "webhook-code-scanning-alert-closed-by-user": {
/** @enum {string} */
- readonly action: "reopened";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly action: "closed_by_user";
+ /** @description The code scanning alert involved in the event. */
+ readonly alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ readonly dismissed_at: string;
/** User */
- readonly assignee?: {
+ readonly dismissed_by: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -45879,7 +38385,199 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- readonly assignees: ({
+ /**
+ * @description The reason for dismissing or closing the alert.
+ * @enum {string|null}
+ */
+ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ readonly html_url: string;
+ /** Alert Instance */
+ readonly most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ readonly analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ readonly category?: string;
+ readonly classifications?: string[];
+ readonly commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ readonly environment: string;
+ readonly location?: {
+ readonly end_column?: number;
+ readonly end_line?: number;
+ readonly path?: string;
+ readonly start_column?: number;
+ readonly start_line?: number;
+ };
+ readonly message?: {
+ readonly text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ readonly ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ readonly number: number;
+ readonly rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description: string;
+ readonly full_description?: string;
+ readonly help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ readonly help_uri?: string | null;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id: string;
+ readonly name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity: "none" | "note" | "warning" | "error" | null;
+ readonly tags?: string[] | null;
+ };
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "dismissed" | "fixed";
+ readonly tool: {
+ readonly guid?: string | null;
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ readonly name: string;
+ /** @description The version of the tool used to detect the alert. */
+ readonly version: string | null;
+ };
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert created event */
+ readonly "webhook-code-scanning-alert-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ /** @description The code scanning alert involved in the event. */
+ readonly alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ readonly created_at: string | null;
+ /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ readonly dismissed_at: unknown;
+ readonly dismissed_by: unknown;
+ readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
+ readonly dismissed_reason: unknown;
+ readonly fixed_at?: unknown;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ readonly html_url: string;
+ readonly instances_url?: string;
+ /** Alert Instance */
+ readonly most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ readonly analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ readonly category?: string;
+ readonly classifications?: string[];
+ readonly commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ readonly environment: string;
+ readonly location?: {
+ readonly end_column?: number;
+ readonly end_line?: number;
+ readonly path?: string;
+ readonly start_column?: number;
+ readonly start_line?: number;
+ };
+ readonly message?: {
+ readonly text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ readonly ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ readonly number: number;
+ readonly rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description: string;
+ readonly full_description?: string;
+ readonly help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ readonly help_uri?: string | null;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id: string;
+ readonly name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity: "none" | "note" | "warning" | "error" | null;
+ readonly tags?: string[] | null;
+ };
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "open" | "dismissed";
+ readonly tool: {
+ readonly guid?: string | null;
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ readonly name: string;
+ /** @description The version of the tool used to detect the alert. */
+ readonly version: string | null;
+ } | null;
+ readonly updated_at?: string | null;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert fixed event */
+ readonly "webhook-code-scanning-alert-fixed": {
+ /** @enum {string} */
+ readonly action: "fixed";
+ /** @description The code scanning alert involved in the event. */
+ readonly alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ readonly dismissed_at: string | null;
+ /** User */
+ readonly dismissed_by: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -45911,271 +38609,303 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null)[];
+ } | null;
/**
- * AuthorAssociation
- * @description How the author is associated with the repository.
+ * @description The reason for dismissing or closing the alert.
+ * @enum {string|null}
+ */
+ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ readonly html_url: string;
+ /** Format: uri */
+ readonly instances_url?: string;
+ /** Alert Instance */
+ readonly most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ readonly analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ readonly category?: string;
+ readonly classifications?: string[];
+ readonly commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ readonly environment: string;
+ readonly location?: {
+ readonly end_column?: number;
+ readonly end_line?: number;
+ readonly path?: string;
+ readonly start_column?: number;
+ readonly start_line?: number;
+ };
+ readonly message?: {
+ readonly text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ readonly ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ readonly number: number;
+ readonly rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description: string;
+ readonly full_description?: string;
+ readonly help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ readonly help_uri?: string | null;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id: string;
+ readonly name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity: "none" | "note" | "warning" | "error" | null;
+ readonly tags?: string[] | null;
+ };
+ /**
+ * @description State of a code scanning alert.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ readonly state: "fixed";
+ readonly tool: {
+ readonly guid?: string | null;
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ readonly name: string;
+ /** @description The version of the tool used to detect the alert. */
+ readonly version: string | null;
+ };
/** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
+ readonly url: string;
+ };
+ readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert reopened event */
+ readonly "webhook-code-scanning-alert-reopened": {
+ /** @enum {string} */
+ readonly action: "reopened";
+ /** @description The code scanning alert involved in the event. */
+ readonly alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
+ /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ readonly dismissed_at: string | null;
+ readonly dismissed_by: Record;
+ /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
+ readonly dismissed_reason: string | null;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ /** Alert Instance */
+ readonly most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ readonly analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ readonly category?: string;
+ readonly classifications?: string[];
+ readonly commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ readonly environment: string;
+ readonly location?: {
+ readonly end_column?: number;
+ readonly end_line?: number;
+ readonly path?: string;
+ readonly start_column?: number;
+ readonly start_line?: number;
+ };
+ readonly message?: {
+ readonly text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ readonly ref: string;
/**
- * Format: uri
- * @description URL for the label
+ * @description State of a code scanning alert.
+ * @enum {string}
*/
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ readonly state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ readonly number: number;
+ readonly rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description: string;
+ readonly full_description?: string;
+ readonly help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ readonly help_uri?: string | null;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id: string;
+ readonly name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity: "none" | "note" | "warning" | "error" | null;
+ readonly tags?: string[] | null;
+ };
/**
- * Milestone
- * @description A collection of related issues and pull requests.
+ * @description State of a code scanning alert.
+ * @enum {string}
*/
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ readonly state: "open" | "dismissed" | "fixed";
+ readonly tool: {
+ readonly guid?: string | null;
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ readonly name: string;
+ /** @description The version of the tool used to detect the alert. */
+ readonly version: string | null;
+ };
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
+ readonly commit_oid: string | null;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
+ readonly ref: string | null;
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert reopened_by_user event */
+ readonly "webhook-code-scanning-alert-reopened-by-user": {
+ /** @enum {string} */
+ readonly action: "reopened_by_user";
+ /** @description The code scanning alert involved in the event. */
+ readonly alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ readonly created_at: string;
+ /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ readonly dismissed_at: unknown;
+ readonly dismissed_by: unknown;
+ /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
+ readonly dismissed_reason: unknown;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ readonly html_url: string;
+ /** Alert Instance */
+ readonly most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ readonly analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ readonly category?: string;
+ readonly classifications?: string[];
+ readonly commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ readonly environment: string;
+ readonly location?: {
+ readonly end_column?: number;
+ readonly end_line?: number;
+ readonly path?: string;
+ readonly start_column?: number;
+ readonly start_line?: number;
+ };
+ readonly message?: {
+ readonly text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ readonly ref: string;
/**
- * @description The state of the milestone.
+ * @description State of a code scanning alert.
* @enum {string}
*/
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
+ readonly state: "open" | "dismissed" | "fixed";
} | null;
- readonly node_id: string;
+ /** @description The code scanning alert number. */
readonly number: number;
+ readonly rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description: string;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity: "none" | "note" | "warning" | "error" | null;
+ };
/**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ * @description State of a code scanning alert.
+ * @enum {string}
*/
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
+ readonly state: "open" | "fixed";
+ readonly tool: {
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
+ /** @description The version of the tool used to detect the alert. */
+ readonly version: string | null;
};
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** commit_comment created event */
+ readonly "webhook-commit-comment-created": {
+ /**
+ * @description The action performed. Can be `created`.
+ * @enum {string}
+ */
+ readonly action: "created";
+ /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */
+ readonly comment: {
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description The text of the comment. */
+ readonly body: string;
+ /** @description The SHA of the commit to which the comment applies. */
+ readonly commit_id: string;
+ readonly created_at: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description The ID of the commit comment. */
+ readonly id: number;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ readonly line: number | null;
+ /** @description The node ID of the commit comment. */
+ readonly node_id: string;
+ /** @description The relative path of the file to which the comment applies. */
+ readonly path: string | null;
+ /** @description The line index in the diff to which the comment applies. */
+ readonly position: number | null;
/** Reactions */
- readonly reactions: {
+ readonly reactions?: {
readonly "+1": number;
readonly "-1": number;
readonly confused: number;
@@ -46188,24 +38918,8 @@ export type components = {
/** Format: uri */
readonly url: string;
};
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
+ /** Format: uri */
readonly url: string;
/** User */
readonly user: {
@@ -46240,453 +38954,271 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
- } & {
- readonly active_lock_reason?: string | null;
- readonly assignee?: Record;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels?: Record[];
- readonly labels_url?: string;
- readonly locked?: boolean;
- readonly milestone?: Record;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- /** @enum {string} */
- readonly state: "open" | "closed";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
};
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** issues transferred event */
- readonly "webhook-issues-transferred": {
+ /** create event */
+ readonly "webhook-create": {
+ /** @description The repository's current description. */
+ readonly description: string | null;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ /** @description The name of the repository's default branch (usually `main`). */
+ readonly master_branch: string;
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"];
+ readonly ref: components["schemas"]["webhooks_ref_0"];
+ /**
+ * @description The type of Git ref object created in the repository.
+ * @enum {string}
+ */
+ readonly ref_type: "tag" | "branch";
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** custom property created event */
+ readonly "webhook-custom-property-created": {
/** @enum {string} */
- readonly action: "transferred";
- readonly changes: {
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly new_issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
+ readonly action: "created";
+ readonly definition: components["schemas"]["org-custom-property"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** custom property deleted event */
+ readonly "webhook-custom-property-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly definition: {
+ /** @description The name of the property that was deleted. */
+ readonly property_name: string;
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** custom property updated event */
+ readonly "webhook-custom-property-updated": {
+ /** @enum {string} */
+ readonly action: "updated";
+ readonly definition: components["schemas"]["org-custom-property"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Custom property values updated event */
+ readonly "webhook-custom-property-values-updated": {
+ /** @enum {string} */
+ readonly action: "updated";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ /** @description The new custom property values for the repository. */
+ readonly new_property_values: components["schemas"]["custom-property-value"][];
+ /** @description The old custom property values for the repository. */
+ readonly old_property_values: components["schemas"]["custom-property-value"][];
+ };
+ /** delete event */
+ readonly "webhook-delete": {
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"];
+ readonly ref: components["schemas"]["webhooks_ref_0"];
+ /**
+ * @description The type of Git ref object deleted in the repository.
+ * @enum {string}
+ */
+ readonly ref_type: "tag" | "branch";
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert auto-dismissed event */
+ readonly "webhook-dependabot-alert-auto-dismissed": {
+ /** @enum {string} */
+ readonly action: "auto_dismissed";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert auto-reopened event */
+ readonly "webhook-dependabot-alert-auto-reopened": {
+ /** @enum {string} */
+ readonly action: "auto_reopened";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert created event */
+ readonly "webhook-dependabot-alert-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert dismissed event */
+ readonly "webhook-dependabot-alert-dismissed": {
+ /** @enum {string} */
+ readonly action: "dismissed";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert fixed event */
+ readonly "webhook-dependabot-alert-fixed": {
+ /** @enum {string} */
+ readonly action: "fixed";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert reintroduced event */
+ readonly "webhook-dependabot-alert-reintroduced": {
+ /** @enum {string} */
+ readonly action: "reintroduced";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert reopened event */
+ readonly "webhook-dependabot-alert-reopened": {
+ /** @enum {string} */
+ readonly action: "reopened";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** deploy_key created event */
+ readonly "webhook-deploy-key-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly key: components["schemas"]["webhooks_deploy_key"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** deploy_key deleted event */
+ readonly "webhook-deploy-key-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly key: components["schemas"]["webhooks_deploy_key"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** deployment created event */
+ readonly "webhook-deployment-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ /**
+ * Deployment
+ * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).
+ */
+ readonly deployment: {
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
/** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
/** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ readonly environment: string;
+ readonly id: number;
+ readonly node_id: string;
+ readonly original_environment: string;
+ readonly payload: Record | string;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
/** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
/** User */
- readonly user: {
+ readonly owner: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -46722,265 +39254,665 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- };
- /**
- * Repository
- * @description A git repository
- */
- readonly new_repository: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly production_environment?: boolean;
+ readonly ref: string;
+ /** Format: uri */
+ readonly repository_url: string;
+ readonly sha: string;
+ /** Format: uri */
+ readonly statuses_url: string;
+ readonly task: string;
+ readonly transient_environment?: boolean;
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly workflow: components["schemas"]["webhooks_workflow"];
+ /** Deployment Workflow Run */
+ readonly workflow_run: {
+ /** User */
+ readonly actor: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
/** Format: uri-template */
- readonly assignees_url: string;
+ readonly following_url?: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly branches_url: string;
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly artifacts_url?: string;
+ readonly cancel_url?: string;
+ readonly check_suite_id: number;
+ readonly check_suite_node_id: string;
+ readonly check_suite_url?: string;
+ /** @enum {string|null} */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly display_title: string;
+ readonly event: string;
+ readonly head_branch: string;
+ readonly head_commit?: unknown;
+ readonly head_repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: unknown;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
+ };
+ readonly head_sha: string;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly jobs_url?: string;
+ readonly logs_url?: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly path: string;
+ readonly previous_attempt_url?: unknown;
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly id: number;
+ readonly number: number;
+ /** Format: uri */
+ readonly url: string;
+ }[];
+ readonly referenced_workflows?: {
+ readonly path: string;
+ readonly ref?: string;
+ readonly sha: string;
+ }[] | null;
+ readonly repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: unknown;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
+ };
+ readonly rerun_url?: string;
+ readonly run_attempt: number;
+ readonly run_number: number;
+ /** Format: date-time */
+ readonly run_started_at: string;
+ /** @enum {string} */
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
+ /** User */
+ readonly triggering_actor?: {
/** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly commits_url: string;
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
/** Format: uri-template */
- readonly compare_url: string;
+ readonly following_url?: string;
/** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
- };
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly downloads_url: string;
+ readonly organizations_url?: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ readonly received_events_url?: string;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly git_tags_url: string;
+ readonly starred_url?: string;
/** Format: uri */
- readonly git_url: string;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- */
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly hooks_url: string;
+ readonly url?: string;
+ } | null;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ readonly workflow_id: number;
+ readonly workflow_url?: string;
+ } | null;
+ };
+ /** deployment protection rule requested event */
+ readonly "webhook-deployment-protection-rule-requested": {
+ /** @enum {string} */
+ readonly action?: "requested";
+ /** @description The name of the environment that has the deployment protection rule. */
+ readonly environment?: string;
+ /** @description The event that triggered the deployment protection rule. */
+ readonly event?: string;
+ /**
+ * Format: uri
+ * @description The URL to review the deployment protection rule.
+ */
+ readonly deployment_callback_url?: string;
+ readonly deployment?: components["schemas"]["deployment"];
+ readonly pull_requests?: components["schemas"]["pull-request"][];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ readonly "webhook-deployment-review-approved": {
+ /** @enum {string} */
+ readonly action: "approved";
+ readonly approver?: components["schemas"]["webhooks_approver"];
+ readonly comment?: string;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly reviewers?: components["schemas"]["webhooks_reviewers"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly since: string;
+ readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"];
+ readonly workflow_job_runs?: {
+ readonly conclusion?: unknown;
+ readonly created_at?: string;
+ readonly environment?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly name?: string | null;
+ readonly status?: string;
+ readonly updated_at?: string;
+ }[];
+ /** Deployment Workflow Run */
+ readonly workflow_run: {
+ /** User */
+ readonly actor: {
/** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly issues_url: string;
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
/** Format: uri-template */
- readonly keys_url: string;
+ readonly following_url?: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly merges_url: string;
- /** Format: uri-template */
- readonly milestones_url: string;
+ readonly organizations_url?: string;
/** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
- /** User */
- readonly owner: {
- /** Format: uri */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly artifacts_url?: string;
+ readonly cancel_url?: string;
+ readonly check_suite_id: number;
+ readonly check_suite_node_id: string;
+ readonly check_suite_url?: string;
+ /** @enum {string|null} */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly display_title: string;
+ readonly event: string;
+ readonly head_branch: string;
+ readonly head_commit?: Record;
+ readonly head_repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
+ readonly type?: string;
readonly url?: string;
- } | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
};
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
- /** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
- /** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
- /** Format: uri */
- readonly subscription_url: string;
- /** Format: uri */
- readonly svn_url: string;
- /** Format: uri */
- readonly tags_url: string;
- /** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
- /** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
+ };
+ readonly head_sha: string;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly jobs_url?: string;
+ readonly logs_url?: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly path: string;
+ readonly previous_attempt_url?: string | null;
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly id: number;
+ readonly number: number;
/** Format: uri */
readonly url: string;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ }[];
+ readonly referenced_workflows?: {
+ readonly path: string;
+ readonly ref?: string;
+ readonly sha: string;
+ }[] | null;
+ readonly repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
};
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly rerun_url?: string;
+ readonly run_attempt: number;
+ readonly run_number: number;
+ /** Format: date-time */
+ readonly run_started_at: string;
+ /** @enum {string} */
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
/** User */
- readonly assignee?: {
+ readonly triggering_actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47016,7 +39948,41 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- readonly assignees: ({
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ readonly workflow_id: number;
+ readonly workflow_url?: string;
+ } | null;
+ };
+ readonly "webhook-deployment-review-rejected": {
+ /** @enum {string} */
+ readonly action: "rejected";
+ readonly approver?: components["schemas"]["webhooks_approver"];
+ readonly comment?: string;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly reviewers?: components["schemas"]["webhooks_reviewers"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly since: string;
+ readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"];
+ readonly workflow_job_runs?: {
+ readonly conclusion?: string | null;
+ readonly created_at?: string;
+ readonly environment?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly name?: string | null;
+ readonly status?: string;
+ readonly updated_at?: string;
+ }[];
+ /** Deployment Workflow Run */
+ readonly workflow_run: {
+ /** User */
+ readonly actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47051,301 +40017,205 @@ export type components = {
readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
+ } | null;
+ readonly artifacts_url?: string;
+ readonly cancel_url?: string;
+ readonly check_suite_id: number;
+ readonly check_suite_node_id: string;
+ readonly check_suite_url?: string;
+ /** @enum {string|null} */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
/** Format: date-time */
readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
+ readonly event: string;
+ readonly head_branch: string;
+ readonly head_commit?: Record;
+ readonly head_repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
+ readonly type?: string;
readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
+ };
+ readonly head_sha: string;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly jobs_url?: string;
+ readonly logs_url?: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly path: string;
+ readonly previous_attempt_url?: string | null;
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
/** Format: uri */
readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
+ }[];
+ readonly referenced_workflows?: {
+ readonly path: string;
+ readonly ref?: string;
+ readonly sha: string;
+ }[] | null;
+ readonly repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
+ readonly type?: string;
readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
};
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
readonly url?: string;
};
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
+ readonly rerun_url?: string;
+ readonly run_attempt: number;
+ readonly run_number: number;
/** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
+ readonly run_started_at: string;
+ /** @enum {string} */
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting";
/** User */
- readonly user: {
+ readonly triggering_actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47353,94 +40223,55 @@ export type components = {
/** Format: uri-template */
readonly events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues unassigned event */
- readonly "webhook-issues-unassigned": {
- /**
- * @description The action that was performed.
- * @enum {string}
- */
- readonly action: "unassigned";
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** Format: date-time */
+ readonly updated_at: string;
/** Format: uri */
- readonly url?: string;
+ readonly url: string;
+ readonly workflow_id: number;
+ readonly workflow_url?: string;
+ readonly display_title: string;
} | null;
+ };
+ readonly "webhook-deployment-review-requested": {
+ /** @enum {string} */
+ readonly action: "requested";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly environment: string;
readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly requestor: components["schemas"]["webhooks_user"];
+ readonly reviewers: {
/** User */
- readonly assignee?: {
+ readonly reviewer?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47457,7 +40288,7 @@ export type components = {
/** Format: uri */
readonly html_url?: string;
readonly id: number;
- readonly login: string;
+ readonly login?: string;
readonly name?: string;
readonly node_id?: string;
/** Format: uri */
@@ -47472,11 +40303,29 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
- readonly assignees: ({
+ /** @enum {string} */
+ readonly type?: "User" | "Team";
+ }[];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly since: string;
+ readonly workflow_job_run: {
+ readonly conclusion: unknown;
+ readonly created_at: string;
+ readonly environment: string;
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string | null;
+ readonly status: string;
+ readonly updated_at: string;
+ };
+ /** Deployment Workflow Run */
+ readonly workflow_run: {
+ /** User */
+ readonly actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47508,359 +40357,208 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
+ } | null;
+ readonly artifacts_url?: string;
+ readonly cancel_url?: string;
+ readonly check_suite_id: number;
+ readonly check_suite_node_id: string;
+ readonly check_suite_url?: string;
+ /** @enum {string|null} */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
/** Format: date-time */
readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
+ readonly event: string;
+ readonly head_branch: string;
+ readonly head_commit?: Record;
+ readonly head_repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
+ readonly type?: string;
readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
+ };
+ readonly head_sha: string;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly jobs_url?: string;
+ readonly logs_url?: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly path: string;
+ readonly previous_attempt_url?: string | null;
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
/** Format: uri */
readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
+ }[];
+ readonly referenced_workflows?: {
+ readonly path: string;
+ readonly ref?: string;
+ readonly sha: string;
+ }[] | null;
+ readonly repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
+ readonly type?: string;
+ readonly url?: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
readonly url?: string;
- } | null;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues unlabeled event */
- readonly "webhook-issues-unlabeled": {
- /** @enum {string} */
- readonly action: "unlabeled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ };
+ readonly rerun_url?: string;
+ readonly run_attempt: number;
+ readonly run_number: number;
+ /** Format: date-time */
+ readonly run_started_at: string;
+ /** @enum {string} */
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
/** User */
- readonly assignee?: {
+ readonly triggering_actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47892,11 +40590,61 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
- readonly assignees: ({
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ readonly workflow_id: number;
+ readonly workflow_url?: string;
+ readonly display_title: string;
+ } | null;
+ };
+ /** deployment_status created event */
+ readonly "webhook-deployment-status-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly check_run?: {
+ /** Format: date-time */
+ readonly completed_at: string | null;
+ /**
+ * @description The result of the completed check run. This value will be `null` until the check run has completed.
+ * @enum {string|null}
+ */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null;
+ /** Format: uri */
+ readonly details_url: string;
+ readonly external_id: string;
+ /** @description The SHA of the commit that is being checked. */
+ readonly head_sha: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description The id of the check. */
+ readonly id: number;
+ /** @description The name of the check run. */
+ readonly name: string;
+ readonly node_id: string;
+ /** Format: date-time */
+ readonly started_at: string;
+ /**
+ * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`.
+ * @enum {string}
+ */
+ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "pending";
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ /**
+ * Deployment
+ * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).
+ */
+ readonly deployment: {
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47928,123 +40676,16 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
} | null;
+ readonly description: string | null;
+ readonly environment: string;
+ readonly id: number;
readonly node_id: string;
- readonly number: number;
+ readonly original_environment: string;
+ readonly payload: (string | Record) | null;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
@@ -48054,7 +40695,7 @@ export type components = {
readonly created_at: string | null;
readonly description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[];
/** Format: uri */
readonly external_url: string | null;
/** Format: uri */
@@ -48138,7 +40779,7 @@ export type components = {
/** @enum {string} */
readonly organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ readonly organization_projects?: "read" | "write";
/** @enum {string} */
readonly organization_secrets?: "read" | "write";
/** @enum {string} */
@@ -48150,333 +40791,99 @@ export type components = {
/** @enum {string} */
readonly pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- /** Label */
- readonly label?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues unlocked event */
- readonly "webhook-issues-unlocked": {
- /** @enum {string} */
- readonly action: "unlocked";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
+ readonly pull_requests?: "read" | "write";
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
/** Format: date-time */
- readonly due_on: string | null;
+ readonly updated_at: string | null;
+ } | null;
+ readonly production_environment?: boolean;
+ readonly ref: string;
+ /** Format: uri */
+ readonly repository_url: string;
+ readonly sha: string;
+ /** Format: uri */
+ readonly statuses_url: string;
+ readonly task: string;
+ readonly transient_environment?: boolean;
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */
+ readonly deployment_status: {
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
/** Format: uri */
- readonly html_url: string;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly organizations_url?: string;
/** Format: uri */
- readonly url: string;
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
} | null;
+ /** Format: uri */
+ readonly deployment_url: string;
+ /** @description The optional human-readable description added to the status. */
+ readonly description: string;
+ readonly environment: string;
+ /** Format: uri */
+ readonly environment_url?: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly log_url?: string;
readonly node_id: string;
- readonly number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
@@ -48486,7 +40893,7 @@ export type components = {
readonly created_at: string | null;
readonly description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[];
/** Format: uri */
readonly external_url: string | null;
/** Format: uri */
@@ -48611,167 +41018,26 @@ export type components = {
/** Format: date-time */
readonly updated_at: string | null;
} | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
/** Format: uri */
readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
+ /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */
+ readonly state: string;
+ /** @description The optional link added to the status. */
+ readonly target_url: string;
readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
+ /** Format: uri */
readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason: unknown;
- readonly assignee?: Record;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels?: Record[];
- readonly labels_url?: string;
- /** @enum {boolean} */
- readonly locked: false;
- readonly milestone?: Record;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: unknown;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- readonly state?: string;
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
};
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues unpinned event */
- readonly "webhook-issues-unpinned": {
- /** @enum {string} */
- readonly action: "unpinned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly workflow?: components["schemas"]["webhooks_workflow"];
+ /** Deployment Workflow Run */
+ readonly workflow_run?: {
/** User */
- readonly assignee?: {
+ readonly actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -48807,336 +41073,205 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
+ readonly artifacts_url?: string;
+ readonly cancel_url?: string;
+ readonly check_suite_id: number;
+ readonly check_suite_node_id: string;
+ readonly check_suite_url?: string;
+ /** @enum {string|null} */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure";
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly display_title: string;
+ readonly event: string;
+ readonly head_branch: string;
+ readonly head_commit?: unknown;
+ readonly head_repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: unknown;
+ readonly downloads_url?: string;
readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
readonly name?: string;
readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
+ readonly type?: string;
readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
+ };
+ readonly head_sha: string;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly jobs_url?: string;
+ readonly logs_url?: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly path: string;
+ readonly previous_attempt_url?: unknown;
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
/** Format: uri */
readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
+ }[];
+ readonly referenced_workflows?: {
+ readonly path: string;
+ readonly ref?: string;
+ readonly sha: string;
+ }[] | null;
+ readonly repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: unknown;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
+ readonly type?: string;
readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
};
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
readonly url?: string;
};
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
+ readonly rerun_url?: string;
+ readonly run_attempt: number;
+ readonly run_number: number;
/** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
+ readonly run_started_at: string;
+ /** @enum {string} */
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
/** User */
- readonly user: {
+ readonly triggering_actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -49172,1055 +41307,930 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ readonly workflow_id: number;
+ readonly workflow_url?: string;
+ } | null;
+ };
+ /** discussion answered event */
+ readonly "webhook-discussion-answered": {
+ /** @enum {string} */
+ readonly action: "answered";
+ readonly answer: components["schemas"]["webhooks_answer"];
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion category changed event */
+ readonly "webhook-discussion-category-changed": {
+ /** @enum {string} */
+ readonly action: "category_changed";
+ readonly changes: {
+ readonly category: {
+ readonly from: {
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly description: string;
+ readonly emoji: string;
+ readonly id: number;
+ readonly is_answerable: boolean;
+ readonly name: string;
+ readonly node_id?: string;
+ readonly repository_id: number;
+ readonly slug: string;
+ readonly updated_at: string;
+ };
+ };
};
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** label created event */
- readonly "webhook-label-created": {
+ /** discussion closed event */
+ readonly "webhook-discussion-closed": {
+ /** @enum {string} */
+ readonly action: "closed";
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion_comment created event */
+ readonly "webhook-discussion-comment-created": {
/** @enum {string} */
readonly action: "created";
+ readonly comment: components["schemas"]["webhooks_comment"];
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** Label */
- readonly label: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** label deleted event */
- readonly "webhook-label-deleted": {
+ /** discussion_comment deleted event */
+ readonly "webhook-discussion-comment-deleted": {
/** @enum {string} */
readonly action: "deleted";
+ readonly comment: components["schemas"]["webhooks_comment"];
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** Label */
- readonly label: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** label edited event */
- readonly "webhook-label-edited": {
+ /** discussion_comment edited event */
+ readonly "webhook-discussion-comment-edited": {
/** @enum {string} */
readonly action: "edited";
- /** @description The changes to the label if the action was `edited`. */
- readonly changes?: {
- readonly color?: {
- /** @description The previous version of the color if the action was `edited`. */
+ readonly changes: {
+ readonly body: {
readonly from: string;
};
- readonly description?: {
- /** @description The previous version of the description if the action was `edited`. */
+ };
+ readonly comment: components["schemas"]["webhooks_comment"];
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion created event */
+ readonly "webhook-discussion-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion deleted event */
+ readonly "webhook-discussion-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion edited event */
+ readonly "webhook-discussion-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ readonly changes?: {
+ readonly body?: {
readonly from: string;
};
- readonly name?: {
- /** @description The previous version of the name if the action was `edited`. */
+ readonly title?: {
readonly from: string;
};
};
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** Label */
- readonly label: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** marketplace_purchase cancelled event */
- readonly "webhook-marketplace-purchase-cancelled": {
+ /** discussion labeled event */
+ readonly "webhook-discussion-labeled": {
/** @enum {string} */
- readonly action: "cancelled";
- readonly effective_date: string;
+ readonly action: "labeled";
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- } & {
- readonly account?: {
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organization_billing_email?: string | null;
- readonly type?: string;
- };
- readonly billing_cycle?: string;
- readonly free_trial_ends_on?: string | null;
- readonly next_billing_date: string | null;
- readonly on_free_trial?: boolean;
- readonly plan?: {
- readonly bullets?: (string | null)[];
- readonly description?: string;
- readonly has_free_trial?: boolean;
- readonly id?: number;
- readonly monthly_price_in_cents?: number;
- readonly name?: string;
- /** @enum {string} */
- readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name?: string | null;
- readonly yearly_price_in_cents?: number;
- };
- readonly unit_count?: number;
- };
+ readonly label: components["schemas"]["webhooks_label"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Marketplace Purchase */
- readonly previous_marketplace_purchase?: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: unknown;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** marketplace_purchase changed event */
- readonly "webhook-marketplace-purchase-changed": {
+ /** discussion locked event */
+ readonly "webhook-discussion-locked": {
/** @enum {string} */
- readonly action: "changed";
- readonly effective_date: string;
+ readonly action: "locked";
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- } & {
- readonly account?: {
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organization_billing_email?: string | null;
- readonly type?: string;
- };
- readonly billing_cycle?: string;
- readonly free_trial_ends_on?: string | null;
- readonly next_billing_date: string | null;
- readonly on_free_trial?: boolean;
- readonly plan?: {
- readonly bullets?: (string | null)[];
- readonly description?: string;
- readonly has_free_trial?: boolean;
- readonly id?: number;
- readonly monthly_price_in_cents?: number;
- readonly name?: string;
- /** @enum {string} */
- readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name?: string | null;
- readonly yearly_price_in_cents?: number;
- };
- readonly unit_count?: number;
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion pinned event */
+ readonly "webhook-discussion-pinned": {
+ /** @enum {string} */
+ readonly action: "pinned";
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion reopened event */
+ readonly "webhook-discussion-reopened": {
+ /** @enum {string} */
+ readonly action: "reopened";
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion transferred event */
+ readonly "webhook-discussion-transferred": {
+ /** @enum {string} */
+ readonly action: "transferred";
+ readonly changes: {
+ readonly new_discussion: components["schemas"]["discussion"];
+ readonly new_repository: components["schemas"]["repository-webhooks"];
};
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Marketplace Purchase */
- readonly previous_marketplace_purchase?: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean | null;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** marketplace_purchase pending_change event */
- readonly "webhook-marketplace-purchase-pending-change": {
+ /** discussion unanswered event */
+ readonly "webhook-discussion-unanswered": {
/** @enum {string} */
- readonly action: "pending_change";
- readonly effective_date: string;
+ readonly action: "unanswered";
+ readonly discussion: components["schemas"]["discussion"];
+ readonly old_answer: components["schemas"]["webhooks_answer"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion unlabeled event */
+ readonly "webhook-discussion-unlabeled": {
+ /** @enum {string} */
+ readonly action: "unlabeled";
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- } & {
- readonly account?: {
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organization_billing_email?: string | null;
- readonly type?: string;
- };
- readonly billing_cycle?: string;
- readonly free_trial_ends_on?: string | null;
- readonly next_billing_date: string | null;
- readonly on_free_trial?: boolean;
- readonly plan?: {
- readonly bullets?: (string | null)[];
- readonly description?: string;
- readonly has_free_trial?: boolean;
- readonly id?: number;
- readonly monthly_price_in_cents?: number;
- readonly name?: string;
- /** @enum {string} */
- readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name?: string | null;
- readonly yearly_price_in_cents?: number;
- };
- readonly unit_count?: number;
- };
+ readonly label: components["schemas"]["webhooks_label"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Marketplace Purchase */
- readonly previous_marketplace_purchase?: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** marketplace_purchase pending_change_cancelled event */
- readonly "webhook-marketplace-purchase-pending-change-cancelled": {
+ /** discussion unlocked event */
+ readonly "webhook-discussion-unlocked": {
/** @enum {string} */
- readonly action: "pending_change_cancelled";
- readonly effective_date: string;
+ readonly action: "unlocked";
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: unknown;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- } & {
- readonly next_billing_date: string;
- };
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Marketplace Purchase */
- readonly previous_marketplace_purchase?: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: unknown;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** marketplace_purchase purchased event */
- readonly "webhook-marketplace-purchase-purchased": {
+ /** discussion unpinned event */
+ readonly "webhook-discussion-unpinned": {
/** @enum {string} */
- readonly action: "purchased";
- readonly effective_date: string;
+ readonly action: "unpinned";
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * fork event
+ * @description A user forks a repository.
+ */
+ readonly "webhook-fork": {
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */
+ readonly forkee: {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow private forks */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ readonly allow_rebase_merge: boolean;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ readonly allow_squash_merge: boolean;
+ readonly allow_update_branch?: boolean;
+ /** Format: uri-template */
+ readonly archive_url: string;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
+ /** Format: uri-template */
+ readonly assignees_url: string;
+ /** Format: uri-template */
+ readonly blobs_url: string;
+ /** Format: uri-template */
+ readonly branches_url: string;
+ /** Format: uri */
+ readonly clone_url: string;
+ /** Format: uri-template */
+ readonly collaborators_url: string;
+ /** Format: uri-template */
+ readonly comments_url: string;
+ /** Format: uri-template */
+ readonly commits_url: string;
+ /** Format: uri-template */
+ readonly compare_url: string;
+ /** Format: uri-template */
+ readonly contents_url: string;
+ /** Format: uri */
+ readonly contributors_url: string;
+ readonly created_at: number | string;
+ /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
+ readonly custom_properties?: {
+ readonly [key: string]: unknown;
};
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
+ /** @description The default branch of the repository. */
+ readonly default_branch: string;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /** Format: uri */
+ readonly deployments_url: string;
+ readonly description: string | null;
+ /** @description Returns whether or not this repository is disabled. */
+ readonly disabled?: boolean;
+ /** Format: uri */
+ readonly downloads_url: string;
+ /** Format: uri */
+ readonly events_url: string;
+ readonly fork: boolean;
+ readonly forks: number;
+ readonly forks_count: number;
+ /** Format: uri */
+ readonly forks_url: string;
+ readonly full_name: string;
+ /** Format: uri-template */
+ readonly git_commits_url: string;
+ /** Format: uri-template */
+ readonly git_refs_url: string;
+ /** Format: uri-template */
+ readonly git_tags_url: string;
+ /** Format: uri */
+ readonly git_url: string;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ readonly has_issues: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ readonly has_wiki: boolean;
+ readonly homepage: string | null;
+ /** Format: uri */
+ readonly hooks_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ readonly is_template?: boolean;
+ /** Format: uri-template */
+ readonly issue_comment_url: string;
+ /** Format: uri-template */
+ readonly issue_events_url: string;
+ /** Format: uri-template */
+ readonly issues_url: string;
+ /** Format: uri-template */
+ readonly keys_url: string;
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly language: string | null;
+ /** Format: uri */
+ readonly languages_url: string;
+ /** License */
+ readonly license: {
+ readonly key: string;
readonly name: string;
+ readonly node_id: string;
+ readonly spdx_id: string;
+ /** Format: uri */
+ readonly url: string | null;
+ } | null;
+ readonly master_branch?: string;
+ /** Format: uri */
+ readonly merges_url: string;
+ /** Format: uri-template */
+ readonly milestones_url: string;
+ /** Format: uri */
+ readonly mirror_url: string | null;
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** Format: uri-template */
+ readonly notifications_url: string;
+ readonly open_issues: number;
+ readonly open_issues_count: number;
+ readonly organization?: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
/** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly pull: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
};
- readonly unit_count: number;
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ readonly public?: boolean;
+ /** Format: uri-template */
+ readonly pulls_url: string;
+ readonly pushed_at: (number | string) | null;
+ /** Format: uri-template */
+ readonly releases_url: string;
+ readonly role_name?: string | null;
+ readonly size: number;
+ readonly ssh_url: string;
+ readonly stargazers?: number;
+ readonly stargazers_count: number;
+ /** Format: uri */
+ readonly stargazers_url: string;
+ /** Format: uri-template */
+ readonly statuses_url: string;
+ /** Format: uri */
+ readonly subscribers_url: string;
+ /** Format: uri */
+ readonly subscription_url: string;
+ /** Format: uri */
+ readonly svn_url: string;
+ /** Format: uri */
+ readonly tags_url: string;
+ /** Format: uri */
+ readonly teams_url: string;
+ readonly topics: string[];
+ /** Format: uri-template */
+ readonly trees_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ /** @enum {string} */
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
} & {
- readonly account?: {
+ readonly allow_forking?: boolean;
+ readonly archive_url?: string;
+ readonly archived?: boolean;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly clone_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly created_at?: string;
+ readonly default_branch?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly disabled?: boolean;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ /** @enum {boolean} */
+ readonly fork?: true;
+ readonly forks?: number;
+ readonly forks_count?: number;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly git_url?: string;
+ readonly has_downloads?: boolean;
+ readonly has_issues?: boolean;
+ readonly has_pages?: boolean;
+ readonly has_projects?: boolean;
+ readonly has_wiki?: boolean;
+ readonly homepage?: string | null;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly is_template?: boolean;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly language?: unknown;
+ readonly languages_url?: string;
+ readonly license?: Record;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly mirror_url?: unknown;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly open_issues?: number;
+ readonly open_issues_count?: number;
+ readonly owner?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
readonly id?: number;
readonly login?: string;
readonly node_id?: string;
- readonly organization_billing_email?: string | null;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
readonly type?: string;
+ readonly url?: string;
};
- readonly billing_cycle?: string;
- readonly free_trial_ends_on?: string | null;
- readonly next_billing_date: string | null;
- readonly on_free_trial?: boolean;
- readonly plan?: {
- readonly bullets?: (string | null)[];
- readonly description?: string;
- readonly has_free_trial?: boolean;
- readonly id?: number;
- readonly monthly_price_in_cents?: number;
- readonly name?: string;
- /** @enum {string} */
- readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name?: string | null;
- readonly yearly_price_in_cents?: number;
- };
- readonly unit_count?: number;
+ readonly private?: boolean;
+ readonly public?: boolean;
+ readonly pulls_url?: string;
+ readonly pushed_at?: string;
+ readonly releases_url?: string;
+ readonly size?: number;
+ readonly ssh_url?: string;
+ readonly stargazers_count?: number;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly svn_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly topics?: unknown[];
+ readonly trees_url?: string;
+ readonly updated_at?: string;
+ readonly url?: string;
+ readonly visibility?: string;
+ readonly watchers?: number;
+ readonly watchers_count?: number;
};
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Marketplace Purchase */
- readonly previous_marketplace_purchase?: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: unknown;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** member added event */
- readonly "webhook-member-added": {
+ /** github_app_authorization revoked event */
+ readonly "webhook-github-app-authorization-revoked": {
/** @enum {string} */
- readonly action: "added";
- readonly changes?: {
- readonly permission?: {
- /** @enum {string} */
- readonly to: "write" | "admin" | "read";
- };
- };
+ readonly action: "revoked";
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** gollum event */
+ readonly "webhook-gollum": {
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** User */
- readonly member: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description The pages that were updated. */
+ readonly pages: {
+ /**
+ * @description The action that was performed on the page. Can be `created` or `edited`.
+ * @enum {string}
+ */
+ readonly action: "created" | "edited";
+ /**
+ * Format: uri
+ * @description Points to the HTML wiki page.
+ */
+ readonly html_url: string;
+ /** @description The name of the page. */
+ readonly page_name: string;
+ /** @description The latest commit SHA of the page. */
+ readonly sha: string;
+ readonly summary: string | null;
+ /** @description The current page title. */
+ readonly title: string;
+ }[];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** member edited event */
- readonly "webhook-member-edited": {
+ /** installation created event */
+ readonly "webhook-installation-created": {
/** @enum {string} */
- readonly action: "edited";
- /** @description The changes to the collaborator permissions */
- readonly changes: {
- readonly old_permission?: {
- /** @description The previous permissions of the collaborator if the action was edited. */
- readonly from: string;
- };
- readonly permission?: {
- readonly from?: string | null;
- readonly to?: string | null;
- };
- };
+ readonly action: "created";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** User */
- readonly member: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
+ readonly installation: components["schemas"]["installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
+ readonly repositories?: components["schemas"]["webhooks_repositories"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly requester?: components["schemas"]["webhooks_user"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** member removed event */
- readonly "webhook-member-removed": {
+ /** installation deleted event */
+ readonly "webhook-installation-deleted": {
/** @enum {string} */
- readonly action: "removed";
+ readonly action: "deleted";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** User */
- readonly member: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
+ readonly installation: components["schemas"]["installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
+ readonly repositories?: components["schemas"]["webhooks_repositories"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly requester?: unknown;
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** membership added event */
- readonly "webhook-membership-added": {
+ /** installation new_permissions_accepted event */
+ readonly "webhook-installation-new-permissions-accepted": {
+ /** @enum {string} */
+ readonly action: "new_permissions_accepted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation: components["schemas"]["installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repositories?: components["schemas"]["webhooks_repositories"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly requester?: unknown;
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** installation_repositories added event */
+ readonly "webhook-installation-repositories-added": {
/** @enum {string} */
readonly action: "added";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** User */
- readonly member: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
+ readonly installation: components["schemas"]["installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repositories_added: components["schemas"]["webhooks_repositories_added"];
+ /** @description An array of repository objects, which were removed from the installation. */
+ readonly repositories_removed: {
+ readonly full_name?: string;
+ /** @description Unique identifier of the repository */
+ readonly id?: number;
+ /** @description The name of the repository. */
readonly name?: string;
readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly organization: components["schemas"]["organization-simple-webhooks"];
+ /** @description Whether the repository is private or public. */
+ readonly private?: boolean;
+ }[];
readonly repository?: components["schemas"]["repository-webhooks"];
- /**
- * @description The scope of the membership. Currently, can only be `team`.
- * @enum {string}
- */
- readonly scope: "team";
- /** User */
- readonly sender: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly team: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /** @enum {string} */
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- };
+ readonly repository_selection: components["schemas"]["webhooks_repository_selection"];
+ readonly requester: components["schemas"]["webhooks_user"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** membership removed event */
- readonly "webhook-membership-removed": {
+ /** installation_repositories removed event */
+ readonly "webhook-installation-repositories-removed": {
/** @enum {string} */
readonly action: "removed";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** User */
- readonly member: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
+ readonly installation: components["schemas"]["installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repositories_added: components["schemas"]["webhooks_repositories_added"];
+ /** @description An array of repository objects, which were removed from the installation. */
+ readonly repositories_removed: {
+ readonly full_name: string;
+ /** @description Unique identifier of the repository */
readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly organization: components["schemas"]["organization-simple-webhooks"];
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ }[];
readonly repository?: components["schemas"]["repository-webhooks"];
- /**
- * @description The scope of the membership. Currently, can only be `team`.
- * @enum {string}
- */
- readonly scope: "team" | "organization";
- /** User */
- readonly sender: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
+ readonly repository_selection: components["schemas"]["webhooks_repository_selection"];
+ readonly requester: components["schemas"]["webhooks_user"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** installation suspend event */
+ readonly "webhook-installation-suspend": {
+ /** @enum {string} */
+ readonly action: "suspend";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation: components["schemas"]["installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repositories?: components["schemas"]["webhooks_repositories"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly requester?: unknown;
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ readonly "webhook-installation-target-renamed": {
+ readonly account: {
+ readonly archived_at?: string | null;
+ readonly avatar_url: string;
+ readonly created_at?: string;
+ readonly description?: unknown;
readonly events_url?: string;
- /** Format: uri */
+ readonly followers?: number;
readonly followers_url?: string;
- /** Format: uri-template */
+ readonly following?: number;
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
+ readonly has_organization_projects?: boolean;
+ readonly has_repository_projects?: boolean;
+ readonly hooks_url?: string;
+ readonly html_url: string;
readonly id: number;
- readonly login: string;
+ readonly is_verified?: boolean;
+ readonly issues_url?: string;
+ readonly login?: string;
+ readonly members_url?: string;
readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
+ readonly node_id: string;
readonly organizations_url?: string;
- /** Format: uri */
+ readonly public_gists?: number;
+ readonly public_members_url?: string;
+ readonly public_repos?: number;
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
+ readonly slug?: string;
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly team: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /** @enum {string} */
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
+ readonly type?: string;
+ readonly updated_at?: string;
readonly url?: string;
+ readonly website_url?: unknown;
};
- };
- readonly "webhook-merge-group-checks-requested": {
/** @enum {string} */
- readonly action: "checks_requested";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly merge_group: components["schemas"]["merge-group"];
+ readonly action: "renamed";
+ readonly changes: {
+ readonly login?: {
+ readonly from: string;
+ };
+ readonly slug?: {
+ readonly from: string;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository?: components["schemas"]["repository-webhooks"];
readonly sender?: components["schemas"]["simple-user-webhooks"];
+ readonly target_type: string;
};
- readonly "webhook-merge-group-destroyed": {
+ /** installation unsuspend event */
+ readonly "webhook-installation-unsuspend": {
/** @enum {string} */
- readonly action: "destroyed";
- /**
- * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated).
- * @enum {string}
- */
- readonly reason?: "merged" | "invalidated" | "dequeued";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly merge_group: components["schemas"]["merge-group"];
+ readonly action: "unsuspend";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation: components["schemas"]["installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repositories?: components["schemas"]["webhooks_repositories"];
readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
+ readonly requester?: unknown;
+ readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** meta deleted event */
- readonly "webhook-meta-deleted": {
+ /** issue_comment created event */
+ readonly "webhook-issue-comment-created": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */
- readonly hook: {
- readonly active: boolean;
- readonly config: {
- /** @enum {string} */
- readonly content_type: "json" | "form";
- readonly insecure_ssl: string;
- readonly secret?: string;
+ readonly action: "created";
+ /**
+ * issue comment
+ * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
+ */
+ readonly comment: {
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue comment */
+ readonly body: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /**
+ * Format: int64
+ * @description Unique identifier of the issue comment
+ */
+ readonly id: number;
+ /** Format: uri */
+ readonly issue_url: string;
+ readonly node_id: string;
+ readonly performed_via_github_app: components["schemas"]["nullable-integration"];
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
/** Format: uri */
readonly url: string;
};
- readonly created_at: string;
- readonly events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[];
- readonly id: number;
- readonly name: string;
- readonly type: string;
+ /** Format: date-time */
readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue comment
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
};
- /** @description The id of the modified webhook. */
- readonly hook_id: number;
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["nullable-repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** milestone closed event */
- readonly "webhook-milestone-closed": {
- /** @enum {string} */
- readonly action: "closed";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly creator: {
+ readonly assignee?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly assignees: ({
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50228,161 +42238,328 @@ export type components = {
/** Format: uri-template */
readonly events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ readonly node_id: string;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
/** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
/** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly patch_url?: string;
/** Format: uri */
readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ readonly repository_url: string;
/**
- * @description The state of the milestone.
+ * @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
readonly title: string;
/** Format: date-time */
readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** milestone created event */
- readonly "webhook-milestone-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
/**
- * @description The state of the milestone.
- * @enum {string}
+ * Format: uri
+ * @description URL for the issue
*/
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** milestone deleted event */
- readonly "webhook-milestone-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
/** User */
- readonly creator: {
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50418,67 +42595,10 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** milestone edited event */
- readonly "webhook-milestone-edited": {
- /** @enum {string} */
- readonly action: "edited";
- /** @description The changes to the milestone if the action was `edited`. */
- readonly changes: {
- readonly description?: {
- /** @description The previous version of the description if the action was `edited`. */
- readonly from: string;
- };
- readonly due_on?: {
- /** @description The previous version of the due date if the action was `edited`. */
- readonly from: string;
- };
- readonly title?: {
- /** @description The previous version of the title if the action was `edited`. */
- readonly from: string;
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
+ } & {
+ readonly active_lock_reason?: string | null;
/** User */
- readonly creator: {
+ readonly assignee: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50514,228 +42634,97 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ readonly assignees?: Record[];
+ readonly author_association?: string;
+ readonly body?: string | null;
+ readonly closed_at?: string | null;
+ readonly comments?: number;
+ readonly comments_url?: string;
+ readonly created_at?: string;
+ readonly events_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ readonly labels_url?: string;
+ readonly locked: boolean;
+ readonly milestone?: Record;
+ readonly node_id?: string;
+ readonly number?: number;
+ readonly performed_via_github_app?: Record;
+ readonly reactions?: {
+ readonly "+1"?: number;
+ readonly "-1"?: number;
+ readonly confused?: number;
+ readonly eyes?: number;
+ readonly heart?: number;
+ readonly hooray?: number;
+ readonly laugh?: number;
+ readonly rocket?: number;
+ readonly total_count?: number;
+ readonly url?: string;
+ };
+ readonly repository_url?: string;
/**
- * @description The state of the milestone.
+ * @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** milestone opened event */
- readonly "webhook-milestone-opened": {
- /** @enum {string} */
- readonly action: "opened";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
+ readonly timeline_url?: string;
+ readonly title?: string;
+ readonly updated_at?: string;
+ readonly url?: string;
+ readonly user?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** org_block blocked event */
- readonly "webhook-org-block-blocked": {
- /** @enum {string} */
- readonly action: "blocked";
- /** User */
- readonly blocked_user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** org_block unblocked event */
- readonly "webhook-org-block-unblocked": {
- /** @enum {string} */
- readonly action: "unblocked";
- /** User */
- readonly blocked_user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly type?: string;
+ readonly url?: string;
+ };
+ };
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** organization deleted event */
- readonly "webhook-organization-deleted": {
+ /** issue_comment deleted event */
+ readonly "webhook-issue-comment-deleted": {
/** @enum {string} */
readonly action: "deleted";
+ readonly comment: components["schemas"]["webhooks_issue_comment"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Membership
- * @description The membership between the user and the organization. Not present when the action is `member_invited`.
- */
- readonly membership?: {
- /** Format: uri */
- readonly organization_url: string;
- readonly role: string;
- readonly state: string;
- /** Format: uri */
- readonly url: string;
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly user: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50767,34 +42756,11 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- };
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** organization member_added event */
- readonly "webhook-organization-member-added": {
- /** @enum {string} */
- readonly action: "member_added";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Membership
- * @description The membership between the user and the organization. Not present when the action is `member_invited`.
- */
- readonly membership: {
- /** Format: uri */
- readonly organization_url: string;
- readonly role: string;
- readonly state: string;
- /** Format: uri */
- readonly url: string;
- /** User */
- readonly user: {
+ readonly assignees: ({
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50826,34 +42792,304 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
- } | null;
- };
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** organization member_invited event */
- readonly "webhook-organization-member-invited": {
- /** @enum {string} */
- readonly action: "member_invited";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The invitation for the user or email if the action is `member_invited`. */
- readonly invitation: {
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
/** Format: date-time */
- readonly created_at: string;
- readonly email: string | null;
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
/** Format: date-time */
- readonly failed_at: string | null;
- readonly failed_reason: string | null;
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ readonly node_id: string;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
/** Format: uri */
- readonly invitation_teams_url: string;
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ readonly url: string;
/** User */
- readonly inviter: {
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50885,76 +43121,14 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- readonly login: string | null;
- readonly node_id: string;
- readonly role: string;
- readonly team_count: number;
- readonly invitation_source?: string;
- };
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- /** User */
- readonly user?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- /** organization member_removed event */
- readonly "webhook-organization-member-removed": {
- /** @enum {string} */
- readonly action: "member_removed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Membership
- * @description The membership between the user and the organization. Not present when the action is `member_invited`.
- */
- readonly membership: {
- /** Format: uri */
- readonly organization_url: string;
- readonly role: string;
- readonly state: string;
- /** Format: uri */
- readonly url: string;
+ } & {
+ readonly active_lock_reason?: string | null;
/** User */
- readonly user: {
+ readonly assignee: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50986,39 +43160,102 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
+ readonly assignees?: Record[];
+ readonly author_association?: string;
+ readonly body?: string | null;
+ readonly closed_at?: string | null;
+ readonly comments?: number;
+ readonly comments_url?: string;
+ readonly created_at?: string;
+ readonly events_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ readonly labels_url?: string;
+ readonly locked: boolean;
+ readonly milestone?: Record;
+ readonly node_id?: string;
+ readonly number?: number;
+ readonly performed_via_github_app?: Record;
+ readonly reactions?: {
+ readonly "+1"?: number;
+ readonly "-1"?: number;
+ readonly confused?: number;
+ readonly eyes?: number;
+ readonly heart?: number;
+ readonly hooray?: number;
+ readonly laugh?: number;
+ readonly rocket?: number;
+ readonly total_count?: number;
+ readonly url?: string;
+ };
+ readonly repository_url?: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ readonly timeline_url?: string;
+ readonly title?: string;
+ readonly updated_at?: string;
+ readonly url?: string;
+ readonly user?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
};
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** organization renamed event */
- readonly "webhook-organization-renamed": {
+ /** issue_comment edited event */
+ readonly "webhook-issue-comment-edited": {
/** @enum {string} */
- readonly action: "renamed";
- readonly changes?: {
- readonly login?: {
- readonly from?: string;
- };
- };
+ readonly action: "edited";
+ readonly changes: components["schemas"]["webhooks_changes"];
+ readonly comment: components["schemas"]["webhooks_issue_comment"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Membership
- * @description The membership between the user and the organization. Not present when the action is `member_invited`.
- */
- readonly membership?: {
- /** Format: uri */
- readonly organization_url: string;
- readonly role: string;
- readonly state: string;
- /** Format: uri */
- readonly url: string;
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly user: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -51050,53 +43287,11 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- };
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Ruby Gems metadata */
- readonly "webhook-rubygems-metadata": {
- readonly name?: string;
- readonly description?: string;
- readonly readme?: string;
- readonly homepage?: string;
- readonly version_info?: {
- readonly version?: string;
- };
- readonly platform?: string;
- readonly metadata?: {
- readonly [key: string]: string | undefined;
- };
- readonly repo?: string;
- readonly dependencies?: {
- readonly [key: string]: string | undefined;
- }[];
- readonly commit_oid?: string;
- };
- /** package published event */
- readonly "webhook-package-published": {
- /** @enum {string} */
- readonly action: "published";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description Information about the package. */
- readonly package: {
- readonly created_at: string | null;
- readonly description: string | null;
- readonly ecosystem: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly namespace: string;
- /** User */
- readonly owner: {
+ readonly assignees: ({
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -51128,14 +43323,62 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
- } | null;
- readonly package_type: string;
- readonly package_version: {
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
/** User */
- readonly author?: {
+ readonly creator: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -51167,193 +43410,399 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- readonly body?: string | Record;
- readonly body_html?: string;
- readonly container_metadata?: {
- readonly labels?: Record;
- readonly manifest?: Record;
- readonly tag?: {
- readonly digest?: string;
- readonly name?: string;
- };
- } | null;
- readonly created_at?: string;
- readonly description: string;
- readonly docker_metadata?: {
- readonly tags?: string[];
- }[];
- readonly draft?: boolean;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
/** Format: uri */
readonly html_url: string;
readonly id: number;
- readonly installation_command: string;
- readonly manifest?: string;
- readonly metadata: {
- readonly [key: string]: unknown;
- }[];
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ readonly node_id: string;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
readonly name: string;
- readonly npm_metadata?: {
- readonly name?: string;
- readonly version?: string;
- readonly npm_user?: string;
- readonly author?: Record;
- readonly bugs?: Record;
- readonly dependencies?: Record;
- readonly dev_dependencies?: Record;
- readonly peer_dependencies?: Record;
- readonly optional_dependencies?: Record;
- readonly description?: string;
- readonly dist?: Record;
- readonly git_head?: string;
- readonly homepage?: string;
- readonly license?: string;
- readonly main?: string;
- readonly repository?: Record;
- readonly scripts?: Record;
- readonly id?: string;
- readonly node_version?: string;
- readonly npm_version?: string;
- readonly has_shrinkwrap?: boolean;
- readonly maintainers?: Record[];
- readonly contributors?: Record[];
- readonly engines?: Record;
- readonly keywords?: string[];
- readonly files?: string[];
- readonly bin?: Record;
- readonly man?: Record;
- readonly directories?: Record;
- readonly os?: string[];
- readonly cpu?: string[];
- readonly readme?: string;
- readonly installation_command?: string;
- readonly release_id?: number;
- readonly commit_oid?: string;
- readonly published_via_actions?: boolean;
- readonly deleted_by_id?: number;
- } | null;
- readonly nuget_metadata?: {
- readonly id?: number | string;
- readonly name?: string;
- readonly value?: boolean | string | number | {
- readonly url?: string;
- readonly branch?: string;
- readonly commit?: string;
- readonly type?: string;
- };
- }[] | null;
- readonly package_files: {
- readonly content_type: string;
- readonly created_at: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
/** Format: uri */
- readonly download_url: string;
- readonly id: number;
- readonly md5: string | null;
- readonly name: string;
- readonly sha1: string | null;
- readonly sha256: string | null;
- readonly size: number;
- readonly state: string | null;
- readonly updated_at: string;
- }[];
- readonly package_url?: string;
- readonly prerelease?: boolean;
- readonly release?: {
- /** User */
- readonly author: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly created_at: string;
- readonly draft: boolean;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
/** Format: uri */
- readonly html_url: string;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
- readonly name: string | null;
- readonly prerelease: boolean;
- readonly published_at: string;
- readonly tag_name: string;
- readonly target_commitish: string;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly url: string;
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
};
- readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
- readonly source_url?: string;
- readonly summary: string;
- readonly tag_name?: string;
- readonly target_commitish?: string;
- readonly target_oid?: string;
- readonly updated_at?: string;
- readonly version: string;
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
} | null;
- readonly registry: {
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Format: uri */
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ } & {
+ readonly active_lock_reason?: string | null;
+ /** User */
+ readonly assignee: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly about_url: string;
- readonly name: string;
- readonly type: string;
+ readonly organizations_url?: string;
/** Format: uri */
- readonly url: string;
- readonly vendor: string;
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
} | null;
- readonly updated_at: string | null;
+ readonly assignees?: Record[];
+ readonly author_association?: string;
+ readonly body?: string | null;
+ readonly closed_at?: string | null;
+ readonly comments?: number;
+ readonly comments_url?: string;
+ readonly created_at?: string;
+ readonly events_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ readonly labels_url?: string;
+ readonly locked: boolean;
+ readonly milestone?: Record;
+ readonly node_id?: string;
+ readonly number?: number;
+ readonly performed_via_github_app?: Record;
+ readonly reactions?: {
+ readonly "+1"?: number;
+ readonly "-1"?: number;
+ readonly confused?: number;
+ readonly eyes?: number;
+ readonly heart?: number;
+ readonly hooray?: number;
+ readonly laugh?: number;
+ readonly rocket?: number;
+ readonly total_count?: number;
+ readonly url?: string;
+ };
+ readonly repository_url?: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ readonly timeline_url?: string;
+ readonly title?: string;
+ readonly updated_at?: string;
+ readonly url?: string;
+ readonly user?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
};
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** package updated event */
- readonly "webhook-package-updated": {
- /** @enum {string} */
- readonly action: "updated";
+ /** issues assigned event */
+ readonly "webhook-issues-assigned": {
+ /**
+ * @description The action that was performed.
+ * @enum {string}
+ */
+ readonly action: "assigned";
+ readonly assignee?: components["schemas"]["webhooks_user"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
+ readonly issue: components["schemas"]["webhooks_issue"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description Information about the package. */
- readonly package: {
- readonly created_at: string;
- readonly description: string | null;
- readonly ecosystem: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly namespace: string;
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues closed event */
+ readonly "webhook-issues-closed": {
+ /**
+ * @description The action that was performed.
+ * @enum {string}
+ */
+ readonly action: "closed";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly owner: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -51385,14 +43834,98 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- readonly package_type: string;
- readonly package_version: {
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
/** User */
- readonly author: {
+ readonly creator: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -51424,130 +43957,217 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- readonly body: string;
- readonly body_html: string;
- readonly created_at: string;
- readonly description: string;
- readonly docker_metadata?: {
- readonly tags?: string[];
- }[];
- readonly draft?: boolean;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
/** Format: uri */
readonly html_url: string;
readonly id: number;
- readonly installation_command: string;
- readonly manifest?: string;
- readonly metadata: {
- readonly [key: string]: unknown;
- }[];
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ readonly node_id: string;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
readonly name: string;
- readonly package_files: {
- readonly content_type: string;
- readonly created_at: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
/** Format: uri */
- readonly download_url: string;
- readonly id: number;
- readonly md5: string | null;
- readonly name: string;
- readonly sha1: string | null;
- readonly sha256: string;
- readonly size: number;
- readonly state: string;
- readonly updated_at: string;
- }[];
- readonly package_url?: string;
- readonly prerelease?: boolean;
- readonly release?: {
- /** User */
- readonly author: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly created_at: string;
- readonly draft: boolean;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
/** Format: uri */
- readonly html_url: string;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
- readonly name: string;
- readonly prerelease: boolean;
- readonly published_at: string;
- readonly tag_name: string;
- readonly target_commitish: string;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly url: string;
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
};
- readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
/** Format: uri */
- readonly source_url?: string;
- readonly summary: string;
- readonly tag_name?: string;
- readonly target_commitish: string;
- readonly target_oid: string;
- readonly updated_at: string;
- readonly version: string;
- };
- readonly registry: {
+ readonly diff_url?: string;
/** Format: uri */
- readonly about_url: string;
- readonly name: string;
- readonly type: string;
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
/** Format: uri */
readonly url: string;
- readonly vendor: string;
- } | null;
- readonly updated_at: string;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** page_build event */
- readonly "webhook-page-build": {
- /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */
- readonly build: {
- readonly commit: string | null;
- readonly created_at: string;
- readonly duration: number;
- readonly error: {
- readonly message: string | null;
};
+ /** Format: uri */
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ readonly url: string;
/** User */
- readonly pusher: {
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -51579,137 +44199,89 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- readonly status: string;
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly id: number;
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** personal_access_token_request approved event */
- readonly "webhook-personal-access-token-request-approved": {
- /** @enum {string} */
- readonly action: "approved";
- readonly personal_access_token_request: components["schemas"]["personal-access-token-request"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly installation: components["schemas"]["simple-installation"];
- };
- /** personal_access_token_request cancelled event */
- readonly "webhook-personal-access-token-request-cancelled": {
- /** @enum {string} */
- readonly action: "cancelled";
- readonly personal_access_token_request: components["schemas"]["personal-access-token-request"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly installation: components["schemas"]["simple-installation"];
- };
- /** personal_access_token_request created event */
- readonly "webhook-personal-access-token-request-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly personal_access_token_request: components["schemas"]["personal-access-token-request"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly installation: components["schemas"]["simple-installation"];
- };
- /** personal_access_token_request denied event */
- readonly "webhook-personal-access-token-request-denied": {
- /** @enum {string} */
- readonly action: "denied";
- readonly personal_access_token_request: components["schemas"]["personal-access-token-request"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly installation: components["schemas"]["simple-installation"];
- };
- readonly "webhook-ping": {
- /**
- * Webhook
- * @description The webhook that is being pinged
- */
- readonly hook?: {
- /** @description Determines whether the hook is actually triggered for the events it subscribes to. */
- readonly active: boolean;
- /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */
- readonly app_id?: number;
- readonly config: {
- readonly content_type?: components["schemas"]["webhook-config-content-type"];
- readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
- readonly secret?: components["schemas"]["webhook-config-secret"];
- readonly url?: components["schemas"]["webhook-config-url"];
+ } & {
+ readonly active_lock_reason?: string | null;
+ readonly assignee?: Record;
+ readonly assignees?: Record[];
+ readonly author_association?: string;
+ readonly body?: string | null;
+ readonly closed_at: string | null;
+ readonly comments?: number;
+ readonly comments_url?: string;
+ readonly created_at?: string;
+ readonly events_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly labels?: Record[];
+ readonly labels_url?: string;
+ readonly locked?: boolean;
+ readonly milestone?: Record;
+ readonly node_id?: string;
+ readonly number?: number;
+ readonly performed_via_github_app?: Record;
+ readonly reactions?: {
+ readonly "+1"?: number;
+ readonly "-1"?: number;
+ readonly confused?: number;
+ readonly eyes?: number;
+ readonly heart?: number;
+ readonly hooray?: number;
+ readonly laugh?: number;
+ readonly rocket?: number;
+ readonly total_count?: number;
+ readonly url?: string;
};
- /** Format: date-time */
- readonly created_at: string;
- /** Format: uri */
- readonly deliveries_url?: string;
- /** @description Determines what events the hook is triggered for. Default: ['push']. */
- readonly events: string[];
- /** @description Unique identifier of the webhook. */
- readonly id: number;
- readonly last_response?: components["schemas"]["hook-response"];
- /**
- * @description The type of webhook. The only valid value is 'web'.
- * @enum {string}
- */
- readonly name: "web";
- /** Format: uri */
- readonly ping_url?: string;
- /** Format: uri */
- readonly test_url?: string;
- readonly type: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
+ readonly repository_url?: string;
+ /** @enum {string} */
+ readonly state: "closed" | "open";
+ readonly timeline_url?: string;
+ readonly title?: string;
+ readonly updated_at?: string;
readonly url?: string;
+ readonly user?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
};
- /** @description The ID of the webhook that triggered the ping. */
- readonly hook_id?: number;
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- /** @description Random string of GitHub zen. */
- readonly zen?: string;
- };
- /** @description The webhooks ping payload encoded with URL encoding. */
- readonly "webhook-ping-form-encoded": {
- /** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** project_card converted event */
- readonly "webhook-project-card-converted": {
+ /** issues deleted event */
+ readonly "webhook-issues-deleted": {
/** @enum {string} */
- readonly action: "converted";
- readonly changes: {
- readonly note: {
- readonly from: string;
- };
- };
+ readonly action: "deleted";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Project Card */
- readonly project_card: {
- readonly after_id?: number | null;
- /** @description Whether or not the card is archived */
- readonly archived: boolean;
- readonly column_id: number;
- /** Format: uri */
- readonly column_url: string;
- /** Format: uri */
- readonly content_url?: string;
- /** Format: date-time */
- readonly created_at: string;
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly creator: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -51745,41 +44317,336 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- /** @description The project card's ID */
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
readonly node_id: string;
- readonly note: string | null;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
/** Format: uri */
- readonly project_url: string;
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
/** Format: date-time */
readonly updated_at: string;
- /** Format: uri */
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
readonly url: string;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** project_card created event */
- readonly "webhook-project-card-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Project Card */
- readonly project_card: {
- readonly after_id?: number | null;
- /** @description Whether or not the card is archived */
- readonly archived: boolean;
- readonly column_id: number;
- /** Format: uri */
- readonly column_url: string;
- /** Format: uri */
- readonly content_url?: string;
- /** Format: date-time */
- readonly created_at: string;
/** User */
- readonly creator: {
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -51815,41 +44682,26 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- /** @description The project card's ID */
- readonly id: number;
- readonly node_id: string;
- readonly note: string | null;
- /** Format: uri */
- readonly project_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
};
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** project_card deleted event */
- readonly "webhook-project-card-deleted": {
+ /** issues demilestoned event */
+ readonly "webhook-issues-demilestoned": {
/** @enum {string} */
- readonly action: "deleted";
+ readonly action: "demilestoned";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Project Card */
- readonly project_card: {
- readonly after_id?: number | null;
- /** @description Whether or not the card is archived */
- readonly archived: boolean;
- readonly column_id: number | null;
- /** Format: uri */
- readonly column_url: string;
- /** Format: uri */
- readonly content_url?: string;
- /** Format: date-time */
- readonly created_at: string;
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly creator: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -51885,46 +44737,7 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- /** @description The project card's ID */
- readonly id: number;
- readonly node_id: string;
- readonly note: string | null;
- /** Format: uri */
- readonly project_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository?: components["schemas"]["nullable-repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** project_card edited event */
- readonly "webhook-project-card-edited": {
- /** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly note: {
- readonly from: string | null;
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Project Card */
- readonly project_card: {
- readonly after_id?: number | null;
- /** @description Whether or not the card is archived */
- readonly archived: boolean;
- readonly column_id: number;
- /** Format: uri */
- readonly column_url: string;
- /** Format: uri */
- readonly content_url?: string;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
+ readonly assignees: ({
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -51956,147 +44769,304 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
- } | null;
- /** @description The project card's ID */
- readonly id: number;
- readonly node_id: string;
- readonly note: string | null;
- /** Format: uri */
- readonly project_url: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
/** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** project_card moved event */
- readonly "webhook-project-card-moved": {
- /** @enum {string} */
- readonly action: "moved";
- readonly changes?: {
- readonly column_id: {
- readonly from: number;
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project_card: {
- readonly after_id?: number | null;
- /** @description Whether or not the card is archived */
- readonly archived: boolean;
- readonly column_id: number;
- /** Format: uri */
- readonly column_url: string;
+ readonly closed_at: string | null;
+ readonly comments: number;
/** Format: uri */
- readonly content_url?: string;
+ readonly comments_url: string;
/** Format: date-time */
readonly created_at: string;
- /** User */
- readonly creator: {
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: ({
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ } | null)[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
+ readonly html_url: string;
+ readonly id: number;
/** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ readonly url: string;
+ } | null;
+ readonly node_id: string;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
/** Format: uri */
- readonly organizations_url?: string;
+ readonly external_url: string | null;
/** Format: uri */
- readonly received_events_url?: string;
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
+ readonly diff_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
/** Format: uri */
readonly url?: string;
- } | null;
- /** @description The project card's ID */
- readonly id: number;
- readonly node_id: string;
- readonly note: string | null;
- /** Format: uri */
- readonly project_url: string;
- /** Format: date-time */
- readonly updated_at: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
/** Format: uri */
- readonly url: string;
- } & {
- readonly after_id: number | null;
- readonly archived?: boolean;
- readonly column_id?: number;
- readonly column_url?: string;
- readonly created_at?: string;
- readonly creator?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- } | null;
- readonly id?: number;
- readonly node_id?: string;
- readonly note?: string | null;
- readonly project_url?: string;
- readonly updated_at?: string;
- readonly url?: string;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** project closed event */
- readonly "webhook-project-closed": {
- /** @enum {string} */
- readonly action: "closed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Project */
- readonly project: {
- /** @description Body of the project */
- readonly body: string | null;
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
/** Format: uri */
- readonly columns_url: string;
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
/** Format: date-time */
- readonly created_at: string;
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ readonly url: string;
/** User */
- readonly creator: {
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -52128,170 +45098,42 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** @description Name of the project */
- readonly name: string;
- readonly node_id: string;
- readonly number: number;
- /** Format: uri */
- readonly owner_url: string;
- /**
- * @description State of the project; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** project_column created event */
- readonly "webhook-project-column-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Project Column */
- readonly project_column: {
- readonly after_id?: number | null;
- /** Format: uri */
- readonly cards_url: string;
- /** Format: date-time */
- readonly created_at: string;
- /** @description The unique identifier of the project column */
- readonly id: number;
- /** @description Name of the project column */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri */
- readonly project_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
};
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** project_column deleted event */
- readonly "webhook-project-column-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ readonly milestone?: components["schemas"]["webhooks_milestone"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Project Column */
- readonly project_column: {
- readonly after_id?: number | null;
- /** Format: uri */
- readonly cards_url: string;
- /** Format: date-time */
- readonly created_at: string;
- /** @description The unique identifier of the project column */
- readonly id: number;
- /** @description Name of the project column */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri */
- readonly project_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository?: components["schemas"]["nullable-repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** project_column edited event */
- readonly "webhook-project-column-edited": {
+ /** issues edited event */
+ readonly "webhook-issues-edited": {
/** @enum {string} */
readonly action: "edited";
+ /** @description The changes to the issue. */
readonly changes: {
- readonly name?: {
+ readonly body?: {
+ /** @description The previous version of the body. */
+ readonly from: string;
+ };
+ readonly title?: {
+ /** @description The previous version of the title. */
readonly from: string;
};
};
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Project Column */
- readonly project_column: {
- readonly after_id?: number | null;
- /** Format: uri */
- readonly cards_url: string;
- /** Format: date-time */
- readonly created_at: string;
- /** @description The unique identifier of the project column */
- readonly id: number;
- /** @description Name of the project column */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri */
- readonly project_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** project_column moved event */
- readonly "webhook-project-column-moved": {
- /** @enum {string} */
- readonly action: "moved";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Project Column */
- readonly project_column: {
- readonly after_id?: number | null;
- /** Format: uri */
- readonly cards_url: string;
- /** Format: date-time */
- readonly created_at: string;
- /** @description The unique identifier of the project column */
- readonly id: number;
- /** @description Name of the project column */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri */
- readonly project_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** project created event */
- readonly "webhook-project-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Project */
- readonly project: {
- /** @description Body of the project */
- readonly body: string | null;
- /** Format: uri */
- readonly columns_url: string;
- /** Format: date-time */
- readonly created_at: string;
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly creator: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -52323,49 +45165,340 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
/** Format: uri */
readonly html_url: string;
+ /** Format: int64 */
readonly id: number;
- /** @description Name of the project */
- readonly name: string;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
readonly node_id: string;
readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
/** Format: uri */
- readonly owner_url: string;
+ readonly repository_url: string;
/**
- * @description State of the project; either 'open' or 'closed'
+ * @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state: "open" | "closed";
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
/** Format: date-time */
readonly updated_at: string;
- /** Format: uri */
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
readonly url: string;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** project deleted event */
- readonly "webhook-project-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Project */
- readonly project: {
- /** @description Body of the project */
- readonly body: string | null;
- /** Format: uri */
- readonly columns_url: string;
- /** Format: date-time */
- readonly created_at: string;
/** User */
- readonly creator: {
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -52397,60 +45530,31 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** @description Name of the project */
- readonly name: string;
- readonly node_id: string;
- readonly number: number;
- /** Format: uri */
- readonly owner_url: string;
- /**
- * @description State of the project; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
};
- readonly repository?: components["schemas"]["nullable-repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
+ readonly label?: components["schemas"]["webhooks_label"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** project edited event */
- readonly "webhook-project-edited": {
+ /** issues labeled event */
+ readonly "webhook-issues-labeled": {
/** @enum {string} */
- readonly action: "edited";
- /** @description The changes to the project if the action was `edited`. */
- readonly changes?: {
- readonly body?: {
- /** @description The previous version of the body if the action was `edited`. */
- readonly from: string;
- };
- readonly name?: {
- /** @description The changes to the project if the action was `edited`. */
- readonly from: string;
- };
- };
+ readonly action: "labeled";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Project */
- readonly project: {
- /** @description Body of the project */
- readonly body: string | null;
- /** Format: uri */
- readonly columns_url: string;
- /** Format: date-time */
- readonly created_at: string;
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly creator: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -52482,49 +45586,11 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** @description Name of the project */
- readonly name: string;
- readonly node_id: string;
- readonly number: number;
- /** Format: uri */
- readonly owner_url: string;
- /**
- * @description State of the project; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** project reopened event */
- readonly "webhook-project-reopened": {
- /** @enum {string} */
- readonly action: "reopened";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Project */
- readonly project: {
- /** @description Body of the project */
- readonly body: string | null;
- /** Format: uri */
- readonly columns_url: string;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
+ readonly assignees: ({
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -52556,300 +45622,360 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
- } | null;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
/** Format: uri */
readonly html_url: string;
+ /** Format: int64 */
readonly id: number;
- /** @description Name of the project */
- readonly name: string;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
readonly node_id: string;
readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
/** Format: uri */
- readonly owner_url: string;
+ readonly repository_url: string;
/**
- * @description State of the project; either 'open' or 'closed'
+ * @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state: "open" | "closed";
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
/** Format: date-time */
readonly updated_at: string;
- /** Format: uri */
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
};
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Projects v2 Project Closed Event */
- readonly "webhook-projects-v2-project-closed": {
- /** @enum {string} */
- readonly action: "closed";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2: components["schemas"]["projects-v2"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** @description A project was created */
- readonly "webhook-projects-v2-project-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2: components["schemas"]["projects-v2"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Projects v2 Project Deleted Event */
- readonly "webhook-projects-v2-project-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2: components["schemas"]["projects-v2"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Projects v2 Project Edited Event */
- readonly "webhook-projects-v2-project-edited": {
- /** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly description?: {
- readonly from?: string | null;
- readonly to?: string | null;
- };
- readonly public?: {
- readonly from?: boolean;
- readonly to?: boolean;
- };
- readonly short_description?: {
- readonly from?: string | null;
- readonly to?: string | null;
- };
- readonly title?: {
- readonly from?: string;
- readonly to?: string;
- };
- };
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2: components["schemas"]["projects-v2"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Projects v2 Item Archived Event */
- readonly "webhook-projects-v2-item-archived": {
- /** @enum {string} */
- readonly action: "archived";
- readonly changes: {
- readonly archived_at?: {
- /** Format: date-time */
- readonly from?: string | null;
- /** Format: date-time */
- readonly to?: string | null;
- };
- };
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Projects v2 Item Converted Event */
- readonly "webhook-projects-v2-item-converted": {
- /** @enum {string} */
- readonly action: "converted";
- readonly changes: {
- readonly content_type?: {
- readonly from?: string | null;
- readonly to?: string;
- };
- };
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Projects v2 Item Created Event */
- readonly "webhook-projects-v2-item-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Projects v2 Item Deleted Event */
- readonly "webhook-projects-v2-item-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Projects v2 Item Edited Event */
- readonly "webhook-projects-v2-item-edited": {
- /** @enum {string} */
- readonly action: "edited";
- readonly changes?: {
- readonly field_value: {
- readonly field_node_id?: string;
- readonly field_type?: string;
- };
- } | {
- readonly body: {
- readonly from?: string | null;
- readonly to?: string | null;
- };
- };
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Projects v2 Item Reordered Event */
- readonly "webhook-projects-v2-item-reordered": {
- /** @enum {string} */
- readonly action: "reordered";
- readonly changes: {
- readonly previous_projects_v2_item_node_id?: {
- readonly from?: string | null;
- readonly to?: string | null;
- };
- };
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Projects v2 Item Restored Event */
- readonly "webhook-projects-v2-item-restored": {
- /** @enum {string} */
- readonly action: "restored";
- readonly changes: {
- readonly archived_at?: {
- /** Format: date-time */
- readonly from?: string | null;
- /** Format: date-time */
- readonly to?: string | null;
- };
- };
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Projects v2 Project Reopened Event */
- readonly "webhook-projects-v2-project-reopened": {
- /** @enum {string} */
- readonly action: "reopened";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2: components["schemas"]["projects-v2"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** public event */
- readonly "webhook-public": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ readonly label?: components["schemas"]["webhooks_label"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request assigned event */
- readonly "webhook-pull-request-assigned": {
+ /** issues locked event */
+ readonly "webhook-issues-locked": {
/** @enum {string} */
- readonly action: "assigned";
- /** User */
- readonly assignee: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
+ readonly action: "locked";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** @description The pull request number. */
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Pull Request */
- readonly pull_request: {
- readonly _links: {
- /** Link */
- readonly comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly commits: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly issue: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comment: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly self: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly statuses: {
- /** Format: uri-template */
- readonly href: string;
- };
- };
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ readonly issue: {
/** @enum {string|null} */
readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
/** User */
- readonly assignee: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -52881,7 +46007,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -52917,7 +46043,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -52927,345 +46053,53 @@ export type components = {
* @enum {string}
*/
readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /**
- * PullRequestAutoMerge
- * @description The status of auto merging a pull request.
- */
- readonly auto_merge: {
- /** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
- /** @description Title for the merge commit message. */
- readonly commit_title: string | null;
- /** User */
- readonly enabled_by: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * @description The merge method to use.
- * @enum {string}
- */
- readonly merge_method: "merge" | "squash" | "rebase";
- } | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: ({
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
/**
- * Repository
- * @description A git repository
- */
- readonly repo: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
- /** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
- /** Format: uri-template */
- readonly assignees_url: string;
- /** Format: uri-template */
- readonly blobs_url: string;
- /** Format: uri-template */
- readonly branches_url: string;
- /** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
- /** Format: uri-template */
- readonly commits_url: string;
- /** Format: uri-template */
- readonly compare_url: string;
- /** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
- /** Format: uri */
- readonly downloads_url: string;
- /** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
- /** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
- /** Format: uri-template */
- readonly git_tags_url: string;
- /** Format: uri */
- readonly git_url: string;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- */
- readonly has_discussions: boolean;
- readonly homepage: string | null;
- /** Format: uri */
- readonly hooks_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
- /** Format: uri-template */
- readonly issues_url: string;
- /** Format: uri-template */
- readonly keys_url: string;
- /** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
- /** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /** Format: uri */
- readonly merges_url: string;
- /** Format: uri-template */
- readonly milestones_url: string;
- /** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- };
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
- /** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
- /** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
- /** Format: uri */
- readonly subscription_url: string;
- /** Format: uri */
- readonly svn_url: string;
- /** Format: uri */
- readonly tags_url: string;
- /** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
- /** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
- };
- readonly sha: string;
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ } | null)[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ /** @enum {boolean} */
+ readonly locked: true;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
/** User */
- readonly user: {
+ readonly creator: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -53301,311 +46135,53 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- };
- readonly body: string | null;
- readonly changed_files?: number;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
- /** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
- /** Format: uri */
- readonly commits_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
- /** Format: uri */
- readonly diff_url: string;
- /** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string | null;
- readonly ref: string;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
/**
- * Repository
- * @description A git repository
+ * @description The state of the milestone.
+ * @enum {string}
*/
- readonly repo: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
- /** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
- /** Format: uri-template */
- readonly assignees_url: string;
- /** Format: uri-template */
- readonly blobs_url: string;
- /** Format: uri-template */
- readonly branches_url: string;
- /** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
- /** Format: uri-template */
- readonly commits_url: string;
- /** Format: uri-template */
- readonly compare_url: string;
- /** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
- /** Format: uri */
- readonly downloads_url: string;
- /** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
- /** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
- /** Format: uri-template */
- readonly git_tags_url: string;
- /** Format: uri */
- readonly git_url: string;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- */
- readonly has_discussions: boolean;
- readonly homepage: string | null;
- /** Format: uri */
- readonly hooks_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
- /** Format: uri-template */
- readonly issues_url: string;
- /** Format: uri-template */
- readonly keys_url: string;
- /** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
- /** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /** Format: uri */
- readonly merges_url: string;
- /** Format: uri-template */
- readonly milestones_url: string;
- /** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- };
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
- /** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
- /** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
- /** Format: uri */
- readonly subscription_url: string;
- /** Format: uri */
- readonly svn_url: string;
- /** Format: uri */
- readonly tags_url: string;
- /** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
- /** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
- } | null;
- readonly sha: string;
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ readonly node_id: string;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
/** User */
- readonly user: {
+ readonly owner: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -53641,38 +46217,186 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- readonly locked: boolean;
- /** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
- /** Format: date-time */
- readonly merged_at: string | null;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues milestoned event */
+ readonly "webhook-issues-milestoned": {
+ /** @enum {string} */
+ readonly action: "milestoned";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly merged_by?: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -53708,6 +46432,82 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: ({
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ } | null)[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
@@ -53780,300 +46580,188 @@ export type components = {
readonly url: string;
} | null;
readonly node_id: string;
- /** @description Number uniquely identifying the pull request within its repository. */
readonly number: number;
- /** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: (({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null) | {
- readonly deleted?: boolean;
- /** @description Description of the team */
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[];
+ /** Format: uri */
+ readonly external_url: string | null;
/** Format: uri */
readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
readonly name: string;
readonly node_id: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
+ /** User */
+ readonly owner: {
/** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ readonly events_url?: string;
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- })[];
- readonly requested_teams: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
+ readonly html_url?: string;
readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
+ readonly url?: string;
} | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- }[];
- /** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
- /** Format: uri */
- readonly review_comments_url: string;
- /**
- * @description State of this Pull Request. Either `open` or `closed`.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** Format: uri */
- readonly statuses_url: string;
- /** @description The title of the pull request. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** pull_request auto_merge_disabled event */
- readonly "webhook-pull-request-auto-merge-disabled": {
- /** @enum {string} */
- readonly action: "auto_merge_disabled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Pull Request */
- readonly pull_request: {
- readonly _links: {
- /** Link */
- readonly comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly commits: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly issue: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comment: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly self: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly statuses: {
- /** Format: uri-template */
- readonly href: string;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
};
- };
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
- /** User */
- readonly assignee: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
/** Format: uri */
- readonly received_events_url?: string;
+ readonly diff_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
/** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly patch_url?: string;
/** Format: uri */
readonly url?: string;
- } | null;
- readonly assignees: ({
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Format: uri */
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -54108,24 +46796,27 @@ export type components = {
readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ } | null;
+ };
+ readonly milestone: components["schemas"]["webhooks_milestone"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues opened event */
+ readonly "webhook-issues-opened": {
+ /** @enum {string} */
+ readonly action: "opened";
+ readonly changes?: {
/**
- * PullRequestAutoMerge
- * @description The status of auto merging a pull request.
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly auto_merge: {
- /** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
- /** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ readonly old_issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly enabled_by: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -54161,299 +46852,7 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- /**
- * @description The merge method to use.
- * @enum {string}
- */
- readonly merge_method: "merge" | "squash" | "rebase";
- } | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
- /**
- * Repository
- * @description A git repository
- */
- readonly repo: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
- /** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
- /** Format: uri-template */
- readonly assignees_url: string;
- /** Format: uri-template */
- readonly blobs_url: string;
- /** Format: uri-template */
- readonly branches_url: string;
- /** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
- /** Format: uri-template */
- readonly commits_url: string;
- /** Format: uri-template */
- readonly compare_url: string;
- /** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
- /** Format: uri */
- readonly downloads_url: string;
- /** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
- /** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
- /** Format: uri-template */
- readonly git_tags_url: string;
- /** Format: uri */
- readonly git_url: string;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- */
- readonly has_discussions: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
- readonly homepage: string | null;
- /** Format: uri */
- readonly hooks_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
- /** Format: uri-template */
- readonly issues_url: string;
- /** Format: uri-template */
- readonly keys_url: string;
- /** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
- /** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /** Format: uri */
- readonly merges_url: string;
- /** Format: uri-template */
- readonly milestones_url: string;
- /** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- };
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
- /** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
- /** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
- /** Format: uri */
- readonly subscription_url: string;
- /** Format: uri */
- readonly svn_url: string;
- /** Format: uri */
- readonly tags_url: string;
- /** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
- /** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
- };
- readonly sha: string;
- /** User */
- readonly user: {
+ readonly assignees: ({
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -54485,205 +46884,142 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly body: string | null;
- readonly changed_files?: number;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
- /** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
- /** Format: uri */
- readonly commits_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
- /** Format: uri */
- readonly diff_url: string;
- /** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
- /**
- * Repository
- * @description A git repository
- */
- readonly repo: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
- /** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
- /** Format: uri-template */
- readonly assignees_url: string;
- /** Format: uri-template */
- readonly blobs_url: string;
- /** Format: uri-template */
- readonly branches_url: string;
- /** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
- /** Format: uri-template */
- readonly commits_url: string;
- /** Format: uri-template */
- readonly compare_url: string;
- /** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
- /** Format: uri */
- readonly downloads_url: string;
- /** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
- /** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
- /** Format: uri-template */
- readonly git_tags_url: string;
- /** Format: uri */
- readonly git_url: string;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
/**
- * @description Whether discussions are enabled.
- * @default false
+ * Format: uri
+ * @description URL for the label
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
- /** Format: uri */
- readonly hooks_url: string;
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
/** Format: uri */
readonly html_url: string;
- /** @description Unique identifier of the repository */
readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
- /** Format: uri-template */
- readonly issues_url: string;
- /** Format: uri-template */
- readonly keys_url: string;
- /** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
/** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
/**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @description The state of the milestone.
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
/** Format: uri */
- readonly merges_url: string;
- /** Format: uri-template */
- readonly milestones_url: string;
+ readonly url: string;
+ } | null;
+ readonly node_id: string;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
/** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
readonly name: string;
readonly node_id: string;
- /** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
/** User */
readonly owner: {
/** Format: uri */
@@ -54721,79 +47057,327 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
+ /** @description The set of permissions for the GitHub app */
readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
};
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
- /** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
/** Format: uri */
- readonly stargazers_url: string;
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Format: uri */
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly statuses_url: string;
+ readonly events_url?: string;
/** Format: uri */
- readonly subscribers_url: string;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly subscription_url: string;
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly svn_url: string;
+ readonly organizations_url?: string;
/** Format: uri */
- readonly tags_url: string;
+ readonly received_events_url?: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ } | null;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ readonly old_repository: {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow private forks */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ readonly allow_rebase_merge: boolean;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ readonly allow_squash_merge: boolean;
+ readonly allow_update_branch?: boolean;
+ /** Format: uri-template */
+ readonly archive_url: string;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
+ /** Format: uri-template */
+ readonly assignees_url: string;
+ /** Format: uri-template */
+ readonly blobs_url: string;
+ /** Format: uri-template */
+ readonly branches_url: string;
+ /** Format: uri */
+ readonly clone_url: string;
+ /** Format: uri-template */
+ readonly collaborators_url: string;
+ /** Format: uri-template */
+ readonly comments_url: string;
+ /** Format: uri-template */
+ readonly commits_url: string;
+ /** Format: uri-template */
+ readonly compare_url: string;
+ /** Format: uri-template */
+ readonly contents_url: string;
+ /** Format: uri */
+ readonly contributors_url: string;
+ readonly created_at: number | string;
+ /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
+ readonly custom_properties?: {
+ readonly [key: string]: unknown;
+ };
+ /** @description The default branch of the repository. */
+ readonly default_branch: string;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /** Format: uri */
+ readonly deployments_url: string;
+ readonly description: string | null;
+ /** @description Returns whether or not this repository is disabled. */
+ readonly disabled?: boolean;
+ /** Format: uri */
+ readonly downloads_url: string;
+ /** Format: uri */
+ readonly events_url: string;
+ readonly fork: boolean;
+ readonly forks: number;
+ readonly forks_count: number;
+ /** Format: uri */
+ readonly forks_url: string;
+ readonly full_name: string;
+ /** Format: uri-template */
+ readonly git_commits_url: string;
+ /** Format: uri-template */
+ readonly git_refs_url: string;
+ /** Format: uri-template */
+ readonly git_tags_url: string;
+ /** Format: uri */
+ readonly git_url: string;
+ /** @description Whether the repository has discussions enabled. */
+ readonly has_discussions?: boolean;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ readonly has_issues: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ readonly has_wiki: boolean;
+ readonly homepage: string | null;
+ /** Format: uri */
+ readonly hooks_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ readonly is_template?: boolean;
+ /** Format: uri-template */
+ readonly issue_comment_url: string;
+ /** Format: uri-template */
+ readonly issue_events_url: string;
+ /** Format: uri-template */
+ readonly issues_url: string;
+ /** Format: uri-template */
+ readonly keys_url: string;
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly language: string | null;
+ /** Format: uri */
+ readonly languages_url: string;
+ /** License */
+ readonly license: {
+ readonly key: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly spdx_id: string;
/** Format: uri */
- readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
- };
- readonly sha: string;
+ readonly url: string | null;
+ } | null;
+ readonly master_branch?: string;
+ /** Format: uri */
+ readonly merges_url: string;
+ /** Format: uri-template */
+ readonly milestones_url: string;
+ /** Format: uri */
+ readonly mirror_url: string | null;
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** Format: uri-template */
+ readonly notifications_url: string;
+ readonly open_issues: number;
+ readonly open_issues_count: number;
+ readonly organization?: string;
/** User */
- readonly user: {
+ readonly owner: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -54829,13 +47413,160 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly pull: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
+ };
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ readonly public?: boolean;
+ /** Format: uri-template */
+ readonly pulls_url: string;
+ readonly pushed_at: (number | string) | null;
+ /** Format: uri-template */
+ readonly releases_url: string;
+ readonly role_name?: string | null;
+ readonly size: number;
+ readonly ssh_url: string;
+ readonly stargazers?: number;
+ readonly stargazers_count: number;
+ /** Format: uri */
+ readonly stargazers_url: string;
+ /** Format: uri-template */
+ readonly statuses_url: string;
+ /** Format: uri */
+ readonly subscribers_url: string;
+ /** Format: uri */
+ readonly subscription_url: string;
+ /** Format: uri */
+ readonly svn_url: string;
+ /** Format: uri */
+ readonly tags_url: string;
+ /** Format: uri */
+ readonly teams_url: string;
+ readonly topics: string[];
+ /** Format: uri-template */
+ readonly trees_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ /** @enum {string} */
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require commit signoff. */
+ readonly web_commit_signoff_required?: boolean;
};
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ /** User */
+ readonly assignee?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
/** Format: uri */
readonly html_url: string;
+ /** Format: int64 */
readonly id: number;
- /** Format: uri */
- readonly issue_url: string;
- readonly labels: {
+ readonly labels?: {
/** @description 6-character hex code, without the leading #, identifying the color */
readonly color: string;
readonly default: boolean;
@@ -54850,17 +47581,329 @@ export type components = {
*/
readonly url: string;
}[];
- readonly locked: boolean;
- /** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ readonly node_id: string;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Format: uri */
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
/** Format: date-time */
- readonly merged_at: string | null;
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues pinned event */
+ readonly "webhook-issues-pinned": {
+ /** @enum {string} */
+ readonly action: "pinned";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly issue: components["schemas"]["webhooks_issue_2"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues reopened event */
+ readonly "webhook-issues-reopened": {
+ /** @enum {string} */
+ readonly action: "reopened";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly merged_by?: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -54896,6 +47939,82 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: ({
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ } | null)[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
@@ -54939,7 +48058,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
@@ -54968,165 +48087,185 @@ export type components = {
readonly url: string;
} | null;
readonly node_id: string;
- /** @description Number uniquely identifying the pull request within its repository. */
readonly number: number;
- /** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: (({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null) | {
- readonly deleted?: boolean;
- /** @description Description of the team */
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[];
+ /** Format: uri */
+ readonly external_url: string | null;
/** Format: uri */
readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
readonly name: string;
readonly node_id: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
+ /** User */
+ readonly owner: {
/** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ readonly events_url?: string;
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- })[];
- readonly requested_teams: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
+ readonly html_url?: string;
readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
+ readonly url?: string;
} | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url?: string;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
readonly url?: string;
- }[];
- /** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
/** Format: uri */
- readonly review_comments_url: string;
+ readonly repository_url: string;
/**
- * @description State of this Pull Request. Either `open` or `closed`.
+ * @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
readonly state: "open" | "closed";
+ readonly state_reason?: string | null;
/** Format: uri */
- readonly statuses_url: string;
- /** @description The title of the pull request. */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
readonly title: string;
/** Format: date-time */
readonly updated_at: string;
- /** Format: uri */
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
readonly url: string;
/** User */
readonly user: {
@@ -55160,161 +48299,30 @@ export type components = {
readonly starred_url?: string;
/** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly reason: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** pull_request auto_merge_enabled event */
- readonly "webhook-pull-request-auto-merge-enabled": {
- /** @enum {string} */
- readonly action: "auto_merge_enabled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Pull Request */
- readonly pull_request: {
- readonly _links: {
- /** Link */
- readonly comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly commits: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly issue: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comment: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly self: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly statuses: {
- /** Format: uri-template */
- readonly href: string;
- };
- };
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
- /** User */
- readonly assignee: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues transferred event */
+ readonly "webhook-issues-transferred": {
+ /** @enum {string} */
+ readonly action: "transferred";
+ readonly changes: {
/**
- * PullRequestAutoMerge
- * @description The status of auto merging a pull request.
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly auto_merge: {
- /** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
- /** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ readonly new_issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly enabled_by: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -55350,299 +48358,7 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- /**
- * @description The merge method to use.
- * @enum {string}
- */
- readonly merge_method: "merge" | "squash" | "rebase";
- } | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
- /**
- * Repository
- * @description A git repository
- */
- readonly repo: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
- /** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
- /** Format: uri-template */
- readonly assignees_url: string;
- /** Format: uri-template */
- readonly blobs_url: string;
- /** Format: uri-template */
- readonly branches_url: string;
- /** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
- /** Format: uri-template */
- readonly commits_url: string;
- /** Format: uri-template */
- readonly compare_url: string;
- /** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
- /** Format: uri */
- readonly downloads_url: string;
- /** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
- /** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
- /** Format: uri-template */
- readonly git_tags_url: string;
- /** Format: uri */
- readonly git_url: string;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- */
- readonly has_discussions: boolean;
- readonly homepage: string | null;
- /** Format: uri */
- readonly hooks_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
- /** Format: uri-template */
- readonly issues_url: string;
- /** Format: uri-template */
- readonly keys_url: string;
- /** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
- /** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /** Format: uri */
- readonly merges_url: string;
- /** Format: uri-template */
- readonly milestones_url: string;
- /** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- };
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
- /** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
- /** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
- /** Format: uri */
- readonly subscription_url: string;
- /** Format: uri */
- readonly svn_url: string;
- /** Format: uri */
- readonly tags_url: string;
- /** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
- /** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
- };
- readonly sha: string;
- /** User */
- readonly user: {
+ readonly assignees: ({
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -55677,202 +48393,139 @@ export type components = {
readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null;
- };
- readonly body: string | null;
- readonly changed_files?: number;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
- /** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
- /** Format: uri */
- readonly commits_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
- /** Format: uri */
- readonly diff_url: string;
- /** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ } | null)[];
/**
- * Repository
- * @description A git repository
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
*/
- readonly repo: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
- /** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
- /** Format: uri-template */
- readonly assignees_url: string;
- /** Format: uri-template */
- readonly blobs_url: string;
- /** Format: uri-template */
- readonly branches_url: string;
- /** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
- /** Format: uri-template */
- readonly commits_url: string;
- /** Format: uri-template */
- readonly compare_url: string;
- /** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /** Format: uri */
- readonly deployments_url: string;
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
- /** Format: uri */
- readonly downloads_url: string;
- /** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
- /** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
- /** Format: uri-template */
- readonly git_tags_url: string;
- /** Format: uri */
- readonly git_url: string;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
/**
- * @description Whether discussions are enabled.
- * @default false
+ * Format: uri
+ * @description URL for the label
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
- /** Format: uri */
- readonly hooks_url: string;
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
/** Format: uri */
readonly html_url: string;
- /** @description Unique identifier of the repository */
readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
- /** Format: uri-template */
- readonly issues_url: string;
- /** Format: uri-template */
- readonly keys_url: string;
- /** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
/** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
/**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @description The state of the milestone.
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
/** Format: uri */
- readonly merges_url: string;
- /** Format: uri-template */
- readonly milestones_url: string;
+ readonly url: string;
+ } | null;
+ readonly node_id: string;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
/** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
readonly name: string;
readonly node_id: string;
- /** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
/** User */
readonly owner: {
/** Format: uri */
@@ -55910,77 +48563,129 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
+ /** @description The set of permissions for the GitHub app */
readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
};
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
- /** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
- /** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
/** Format: uri */
- readonly subscription_url: string;
+ readonly diff_url?: string;
/** Format: uri */
- readonly svn_url: string;
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
/** Format: uri */
- readonly tags_url: string;
+ readonly patch_url?: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
- /** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
/** Format: uri */
readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ /** Format: uri */
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ readonly url: string;
/** User */
readonly user: {
/** Format: uri */
@@ -56019,37 +48724,302 @@ export type components = {
readonly url?: string;
} | null;
};
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly issue_url: string;
- readonly labels: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ readonly new_repository: {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow private forks */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ readonly allow_rebase_merge: boolean;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ readonly allow_squash_merge: boolean;
+ readonly allow_update_branch?: boolean;
+ /** Format: uri-template */
+ readonly archive_url: string;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
+ /** Format: uri-template */
+ readonly assignees_url: string;
+ /** Format: uri-template */
+ readonly blobs_url: string;
+ /** Format: uri-template */
+ readonly branches_url: string;
+ /** Format: uri */
+ readonly clone_url: string;
+ /** Format: uri-template */
+ readonly collaborators_url: string;
+ /** Format: uri-template */
+ readonly comments_url: string;
+ /** Format: uri-template */
+ readonly commits_url: string;
+ /** Format: uri-template */
+ readonly compare_url: string;
+ /** Format: uri-template */
+ readonly contents_url: string;
+ /** Format: uri */
+ readonly contributors_url: string;
+ readonly created_at: number | string;
+ /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
+ readonly custom_properties?: {
+ readonly [key: string]: unknown;
+ };
+ /** @description The default branch of the repository. */
+ readonly default_branch: string;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /** Format: uri */
+ readonly deployments_url: string;
readonly description: string | null;
+ /** @description Returns whether or not this repository is disabled. */
+ readonly disabled?: boolean;
+ /** Format: uri */
+ readonly downloads_url: string;
+ /** Format: uri */
+ readonly events_url: string;
+ readonly fork: boolean;
+ readonly forks: number;
+ readonly forks_count: number;
+ /** Format: uri */
+ readonly forks_url: string;
+ readonly full_name: string;
+ /** Format: uri-template */
+ readonly git_commits_url: string;
+ /** Format: uri-template */
+ readonly git_refs_url: string;
+ /** Format: uri-template */
+ readonly git_tags_url: string;
+ /** Format: uri */
+ readonly git_url: string;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ readonly has_issues: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ readonly has_wiki: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ readonly has_discussions: boolean;
+ readonly homepage: string | null;
+ /** Format: uri */
+ readonly hooks_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the repository */
readonly id: number;
- /** @description The name of the label. */
+ readonly is_template?: boolean;
+ /** Format: uri-template */
+ readonly issue_comment_url: string;
+ /** Format: uri-template */
+ readonly issue_events_url: string;
+ /** Format: uri-template */
+ readonly issues_url: string;
+ /** Format: uri-template */
+ readonly keys_url: string;
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly language: string | null;
+ /** Format: uri */
+ readonly languages_url: string;
+ /** License */
+ readonly license: {
+ readonly key: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly spdx_id: string;
+ /** Format: uri */
+ readonly url: string | null;
+ } | null;
+ readonly master_branch?: string;
+ /** Format: uri */
+ readonly merges_url: string;
+ /** Format: uri-template */
+ readonly milestones_url: string;
+ /** Format: uri */
+ readonly mirror_url: string | null;
+ /** @description The name of the repository. */
readonly name: string;
readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
+ /** Format: uri-template */
+ readonly notifications_url: string;
+ readonly open_issues: number;
+ readonly open_issues_count: number;
+ readonly organization?: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly pull: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
+ };
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ readonly public?: boolean;
+ /** Format: uri-template */
+ readonly pulls_url: string;
+ readonly pushed_at: (number | string) | null;
+ /** Format: uri-template */
+ readonly releases_url: string;
+ readonly role_name?: string | null;
+ readonly size: number;
+ readonly ssh_url: string;
+ readonly stargazers?: number;
+ readonly stargazers_count: number;
+ /** Format: uri */
+ readonly stargazers_url: string;
+ /** Format: uri-template */
+ readonly statuses_url: string;
+ /** Format: uri */
+ readonly subscribers_url: string;
+ /** Format: uri */
+ readonly subscription_url: string;
+ /** Format: uri */
+ readonly svn_url: string;
+ /** Format: uri */
+ readonly tags_url: string;
+ /** Format: uri */
+ readonly teams_url: string;
+ readonly topics: string[];
+ /** Format: uri-template */
+ readonly trees_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
readonly url: string;
- }[];
- readonly locked: boolean;
- /** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
- /** Format: date-time */
- readonly merged_at: string | null;
+ /** @enum {string} */
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly issue: components["schemas"]["webhooks_issue_2"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues unassigned event */
+ readonly "webhook-issues-unassigned": {
+ /**
+ * @description The action that was performed.
+ * @enum {string}
+ */
+ readonly action: "unassigned";
+ readonly assignee?: components["schemas"]["webhooks_user_mannequin"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly issue: components["schemas"]["webhooks_issue"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues unlabeled event */
+ readonly "webhook-issues-unlabeled": {
+ /** @enum {string} */
+ readonly action: "unlabeled";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly issue: components["schemas"]["webhooks_issue"];
+ readonly label?: components["schemas"]["webhooks_label"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues unlocked event */
+ readonly "webhook-issues-unlocked": {
+ /** @enum {string} */
+ readonly action: "unlocked";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly merged_by?: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -56085,6 +49055,83 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: ({
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ } | null)[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ /** @enum {boolean} */
+ readonly locked: false;
/**
* Milestone
* @description A collection of related issues and pull requests.
@@ -56128,7 +49175,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -56157,12 +49204,188 @@ export type components = {
readonly url: string;
} | null;
readonly node_id: string;
- /** @description Number uniquely identifying the pull request within its repository. */
readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: (({
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -56194,387 +49417,567 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null) | {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
+ } | null;
+ };
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues unpinned event */
+ readonly "webhook-issues-unpinned": {
+ /** @enum {string} */
+ readonly action: "unpinned";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly issue: components["schemas"]["webhooks_issue_2"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** label created event */
+ readonly "webhook-label-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly label: components["schemas"]["webhooks_label"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** label deleted event */
+ readonly "webhook-label-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly label: components["schemas"]["webhooks_label"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** label edited event */
+ readonly "webhook-label-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ /** @description The changes to the label if the action was `edited`. */
+ readonly changes?: {
+ readonly color?: {
+ /** @description The previous version of the color if the action was `edited`. */
+ readonly from: string;
+ };
+ readonly description?: {
+ /** @description The previous version of the description if the action was `edited`. */
+ readonly from: string;
+ };
+ readonly name?: {
+ /** @description The previous version of the name if the action was `edited`. */
+ readonly from: string;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly label: components["schemas"]["webhooks_label"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** marketplace_purchase cancelled event */
+ readonly "webhook-marketplace-purchase-cancelled": {
+ /** @enum {string} */
+ readonly action: "cancelled";
+ readonly effective_date: string;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** marketplace_purchase changed event */
+ readonly "webhook-marketplace-purchase-changed": {
+ /** @enum {string} */
+ readonly action: "changed";
+ readonly effective_date: string;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Marketplace Purchase */
+ readonly previous_marketplace_purchase?: {
+ readonly account: {
readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
+ readonly login: string;
+ readonly node_id: string;
+ readonly organization_billing_email: string | null;
+ readonly type: string;
+ };
+ readonly billing_cycle: string;
+ readonly free_trial_ends_on: string | null;
+ readonly next_billing_date?: string | null;
+ readonly on_free_trial: boolean | null;
+ readonly plan: {
+ readonly bullets: string[];
+ readonly description: string;
+ readonly has_free_trial: boolean;
+ readonly id: number;
+ readonly monthly_price_in_cents: number;
readonly name: string;
+ /** @enum {string} */
+ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ readonly unit_name: string | null;
+ readonly yearly_price_in_cents: number;
+ };
+ readonly unit_count: number;
+ };
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** marketplace_purchase pending_change event */
+ readonly "webhook-marketplace-purchase-pending-change": {
+ /** @enum {string} */
+ readonly action: "pending_change";
+ readonly effective_date: string;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Marketplace Purchase */
+ readonly previous_marketplace_purchase?: {
+ readonly account: {
+ readonly id: number;
+ readonly login: string;
readonly node_id: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ readonly organization_billing_email: string | null;
+ readonly type: string;
+ };
+ readonly billing_cycle: string;
+ readonly free_trial_ends_on: string | null;
+ readonly next_billing_date?: string | null;
+ readonly on_free_trial: boolean;
+ readonly plan: {
+ readonly bullets: string[];
+ readonly description: string;
+ readonly has_free_trial: boolean;
+ readonly id: number;
+ readonly monthly_price_in_cents: number;
+ readonly name: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- })[];
- readonly requested_teams: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
+ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ readonly unit_name: string | null;
+ readonly yearly_price_in_cents: number;
+ };
+ readonly unit_count: number;
+ };
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** marketplace_purchase pending_change_cancelled event */
+ readonly "webhook-marketplace-purchase-pending-change-cancelled": {
+ /** @enum {string} */
+ readonly action: "pending_change_cancelled";
+ readonly effective_date: string;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ /** Marketplace Purchase */
+ readonly marketplace_purchase: {
+ readonly account: {
readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
+ readonly login: string;
+ readonly node_id: string;
+ readonly organization_billing_email: string | null;
+ readonly type: string;
+ };
+ readonly billing_cycle: string;
+ readonly free_trial_ends_on: unknown;
+ readonly next_billing_date: string | null;
+ readonly on_free_trial: boolean;
+ readonly plan: {
+ readonly bullets: string[];
+ readonly description: string;
+ readonly has_free_trial: boolean;
+ readonly id: number;
+ readonly monthly_price_in_cents: number;
readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- }[];
+ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ readonly unit_name: string | null;
+ readonly yearly_price_in_cents: number;
+ };
+ readonly unit_count: number;
+ };
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** marketplace_purchase purchased event */
+ readonly "webhook-marketplace-purchase-purchased": {
+ /** @enum {string} */
+ readonly action: "purchased";
+ readonly effective_date: string;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** member added event */
+ readonly "webhook-member-added": {
+ /** @enum {string} */
+ readonly action: "added";
+ readonly changes?: {
+ /** @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain`
+ * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role
+ * assigned to the collaborator, use the `role_name` field instead, which will provide the full
+ * role name, including custom roles. */
+ readonly permission?: {
+ /** @enum {string} */
+ readonly to: "write" | "admin" | "read";
+ };
+ /** @description The role assigned to the collaborator. */
+ readonly role_name?: {
+ readonly to: string;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly member: components["schemas"]["webhooks_user"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** member edited event */
+ readonly "webhook-member-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ /** @description The changes to the collaborator permissions */
+ readonly changes: {
+ readonly old_permission?: {
+ /** @description The previous permissions of the collaborator if the action was edited. */
+ readonly from: string;
+ };
+ readonly permission?: {
+ readonly from?: string | null;
+ readonly to?: string | null;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly member: components["schemas"]["webhooks_user"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** member removed event */
+ readonly "webhook-member-removed": {
+ /** @enum {string} */
+ readonly action: "removed";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly member: components["schemas"]["webhooks_user"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** membership added event */
+ readonly "webhook-membership-added": {
+ /** @enum {string} */
+ readonly action: "added";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly member: components["schemas"]["webhooks_user"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ /**
+ * @description The scope of the membership. Currently, can only be `team`.
+ * @enum {string}
+ */
+ readonly scope: "team";
+ /** User */
+ readonly sender: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ readonly events_url?: string;
/** Format: uri */
- readonly review_comments_url: string;
- /**
- * @description State of this Pull Request. Either `open` or `closed`.
- * @enum {string}
- */
- readonly state: "open" | "closed";
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly statuses_url: string;
- /** @description The title of the pull request. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly team: components["schemas"]["webhooks_team"];
+ };
+ /** membership removed event */
+ readonly "webhook-membership-removed": {
+ /** @enum {string} */
+ readonly action: "removed";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly member: components["schemas"]["webhooks_user"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ /**
+ * @description The scope of the membership. Currently, can only be `team`.
+ * @enum {string}
+ */
+ readonly scope: "team" | "organization";
+ /** User */
+ readonly sender: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly team: components["schemas"]["webhooks_team"];
+ };
+ readonly "webhook-merge-group-checks-requested": {
+ /** @enum {string} */
+ readonly action: "checks_requested";
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly merge_group: components["schemas"]["merge-group"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ readonly "webhook-merge-group-destroyed": {
+ /** @enum {string} */
+ readonly action: "destroyed";
+ /**
+ * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated).
+ * @enum {string}
+ */
+ readonly reason?: "merged" | "invalidated" | "dequeued";
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly merge_group: components["schemas"]["merge-group"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** meta deleted event */
+ readonly "webhook-meta-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */
+ readonly hook: {
+ readonly active: boolean;
+ readonly config: {
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly content_type: "json" | "form";
+ readonly insecure_ssl: string;
+ readonly secret?: string;
/** Format: uri */
- readonly url?: string;
- } | null;
+ readonly url: string;
+ };
+ readonly created_at: string;
+ readonly events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[];
+ readonly id: number;
+ readonly name: string;
+ readonly type: string;
+ readonly updated_at: string;
};
- readonly reason?: string;
+ /** @description The id of the modified webhook. */
+ readonly hook_id: number;
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["nullable-repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** milestone closed event */
+ readonly "webhook-milestone-closed": {
+ /** @enum {string} */
+ readonly action: "closed";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly milestone: components["schemas"]["webhooks_milestone"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request closed event */
- readonly "webhook-pull-request-closed": {
+ /** milestone created event */
+ readonly "webhook-milestone-created": {
/** @enum {string} */
- readonly action: "closed";
+ readonly action: "created";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** @description The pull request number. */
- readonly number: number;
+ readonly milestone: components["schemas"]["webhooks_milestone_3"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["pull-request"] & {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow updating the pull request's branch. */
- readonly allow_update_branch?: boolean;
- /**
- * @description Whether to delete head branches when pull requests are merged.
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /**
- * @description The default value for a merge commit message.
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name").
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a squash merge commit message:
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- };
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request converted_to_draft event */
- readonly "webhook-pull-request-converted-to-draft": {
+ /** milestone deleted event */
+ readonly "webhook-milestone-deleted": {
/** @enum {string} */
- readonly action: "converted_to_draft";
+ readonly action: "deleted";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** @description The pull request number. */
- readonly number: number;
+ readonly milestone: components["schemas"]["webhooks_milestone"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["pull-request"] & {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow updating the pull request's branch. */
- readonly allow_update_branch?: boolean;
- /**
- * @description Whether to delete head branches when pull requests are merged.
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /**
- * @description The default value for a merge commit message.
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name").
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a squash merge commit message:
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** milestone edited event */
+ readonly "webhook-milestone-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ /** @description The changes to the milestone if the action was `edited`. */
+ readonly changes: {
+ readonly description?: {
+ /** @description The previous version of the description if the action was `edited`. */
+ readonly from: string;
+ };
+ readonly due_on?: {
+ /** @description The previous version of the due date if the action was `edited`. */
+ readonly from: string;
+ };
+ readonly title?: {
+ /** @description The previous version of the title if the action was `edited`. */
+ readonly from: string;
+ };
};
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly milestone: components["schemas"]["webhooks_milestone"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** milestone opened event */
+ readonly "webhook-milestone-opened": {
+ /** @enum {string} */
+ readonly action: "opened";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly milestone: components["schemas"]["webhooks_milestone_3"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request demilestoned event */
- readonly "webhook-pull-request-demilestoned": {
+ /** org_block blocked event */
+ readonly "webhook-org-block-blocked": {
+ /** @enum {string} */
+ readonly action: "blocked";
+ readonly blocked_user: components["schemas"]["webhooks_user"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** org_block unblocked event */
+ readonly "webhook-org-block-unblocked": {
/** @enum {string} */
- readonly action: "demilestoned";
+ readonly action: "unblocked";
+ readonly blocked_user: components["schemas"]["webhooks_user"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly milestone?: components["schemas"]["milestone"];
- /** @description The pull request number. */
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Pull Request */
- readonly pull_request: {
- readonly _links: {
- /** Link */
- readonly comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly commits: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly issue: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comment: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly self: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly statuses: {
- /** Format: uri-template */
- readonly href: string;
- };
- };
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** organization deleted event */
+ readonly "webhook-organization-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly membership?: components["schemas"]["webhooks_membership"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** organization member_added event */
+ readonly "webhook-organization-member-added": {
+ /** @enum {string} */
+ readonly action: "member_added";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly membership: components["schemas"]["webhooks_membership"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** organization member_invited event */
+ readonly "webhook-organization-member-invited": {
+ /** @enum {string} */
+ readonly action: "member_invited";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ /** @description The invitation for the user or email if the action is `member_invited`. */
+ readonly invitation: {
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly email: string | null;
+ /** Format: date-time */
+ readonly failed_at: string | null;
+ readonly failed_reason: string | null;
+ readonly id: number;
+ /** Format: uri */
+ readonly invitation_teams_url: string;
/** User */
- readonly assignee: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
+ readonly inviter: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -56606,355 +50009,125 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /**
- * PullRequestAutoMerge
- * @description The status of auto merging a pull request.
- */
- readonly auto_merge: {
- /** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
- /** @description Title for the merge commit message. */
- readonly commit_title: string | null;
- /** User */
- readonly enabled_by: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * @description The merge method to use.
- * @enum {string}
- */
- readonly merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
- /**
- * Repository
- * @description A git repository
- */
- readonly repo: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
- /** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
- /** Format: uri-template */
- readonly assignees_url: string;
- /** Format: uri-template */
- readonly blobs_url: string;
- /** Format: uri-template */
- readonly branches_url: string;
- /** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
- /** Format: uri-template */
- readonly commits_url: string;
- /** Format: uri-template */
- readonly compare_url: string;
- /** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
- /** Format: uri */
- readonly downloads_url: string;
- /** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
- /** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
- /** Format: uri-template */
- readonly git_tags_url: string;
- /** Format: uri */
- readonly git_url: string;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- */
- readonly has_discussions: boolean;
- readonly homepage: string | null;
- /** Format: uri */
- readonly hooks_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
- /** Format: uri-template */
- readonly issues_url: string;
- /** Format: uri-template */
- readonly keys_url: string;
- /** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
- /** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /** Format: uri */
- readonly merges_url: string;
- /** Format: uri-template */
- readonly milestones_url: string;
- /** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- };
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
- /** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
- /** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
- /** Format: uri */
- readonly subscription_url: string;
- /** Format: uri */
- readonly svn_url: string;
- /** Format: uri */
- readonly tags_url: string;
- /** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
- /** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
- };
- readonly sha: string;
+ readonly login: string | null;
+ readonly node_id: string;
+ readonly role: string;
+ readonly team_count: number;
+ readonly invitation_source?: string;
+ };
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly user?: components["schemas"]["webhooks_user"];
+ };
+ /** organization member_removed event */
+ readonly "webhook-organization-member-removed": {
+ /** @enum {string} */
+ readonly action: "member_removed";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly membership: components["schemas"]["webhooks_membership"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** organization renamed event */
+ readonly "webhook-organization-renamed": {
+ /** @enum {string} */
+ readonly action: "renamed";
+ readonly changes?: {
+ readonly login?: {
+ readonly from?: string;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly membership?: components["schemas"]["webhooks_membership"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Ruby Gems metadata */
+ readonly "webhook-rubygems-metadata": {
+ readonly name?: string;
+ readonly description?: string;
+ readonly readme?: string;
+ readonly homepage?: string;
+ readonly version_info?: {
+ readonly version?: string;
+ };
+ readonly platform?: string;
+ readonly metadata?: {
+ readonly [key: string]: string | undefined;
+ };
+ readonly repo?: string;
+ readonly dependencies?: {
+ readonly [key: string]: string | undefined;
+ }[];
+ readonly commit_oid?: string;
+ };
+ /** package published event */
+ readonly "webhook-package-published": {
+ /** @enum {string} */
+ readonly action: "published";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description Information about the package. */
+ readonly package: {
+ readonly created_at: string | null;
+ readonly description: string | null;
+ readonly ecosystem: string;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string;
+ readonly namespace: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly package_type: string;
+ readonly package_version: {
/** User */
- readonly user: {
+ readonly author?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -56990,203 +50163,99 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- };
- readonly body: string | null;
- readonly changed_files?: number;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
- /** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
- /** Format: uri */
- readonly commits_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
- /** Format: uri */
- readonly diff_url: string;
- /** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
- /**
- * Repository
- * @description A git repository
- */
- readonly repo: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
- /** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
- /** Format: uri-template */
- readonly assignees_url: string;
- /** Format: uri-template */
- readonly blobs_url: string;
- /** Format: uri-template */
- readonly branches_url: string;
- /** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
- /** Format: uri-template */
- readonly commits_url: string;
- /** Format: uri-template */
- readonly compare_url: string;
- /** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
- /** Format: uri */
- readonly downloads_url: string;
- /** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
- /** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
- /** Format: uri-template */
- readonly git_tags_url: string;
- /** Format: uri */
- readonly git_url: string;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- */
- readonly has_discussions: boolean;
- readonly homepage: string | null;
- /** Format: uri */
- readonly hooks_url: string;
+ readonly body?: string | Record;
+ readonly body_html?: string;
+ readonly container_metadata?: {
+ readonly labels?: Record;
+ readonly manifest?: Record;
+ readonly tag?: {
+ readonly digest?: string;
+ readonly name?: string;
+ };
+ } | null;
+ readonly created_at?: string;
+ readonly description: string;
+ readonly docker_metadata?: {
+ readonly tags?: string[];
+ }[];
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly installation_command: string;
+ readonly manifest?: string;
+ readonly metadata: {
+ readonly [key: string]: unknown;
+ }[];
+ readonly name: string;
+ readonly npm_metadata?: {
+ readonly name?: string;
+ readonly version?: string;
+ readonly npm_user?: string;
+ readonly author?: Record;
+ readonly bugs?: Record;
+ readonly dependencies?: Record;
+ readonly dev_dependencies?: Record;
+ readonly peer_dependencies?: Record;
+ readonly optional_dependencies?: Record;
+ readonly description?: string;
+ readonly dist?: Record;
+ readonly git_head?: string;
+ readonly homepage?: string;
+ readonly license?: string;
+ readonly main?: string;
+ readonly repository?: Record;
+ readonly scripts?: Record;
+ readonly id?: string;
+ readonly node_version?: string;
+ readonly npm_version?: string;
+ readonly has_shrinkwrap?: boolean;
+ readonly maintainers?: Record[];
+ readonly contributors?: Record[];
+ readonly engines?: Record;
+ readonly keywords?: string[];
+ readonly files?: string[];
+ readonly bin?: Record;
+ readonly man?: Record;
+ readonly directories?: Record;
+ readonly os?: string[];
+ readonly cpu?: string[];
+ readonly readme?: string;
+ readonly installation_command?: string;
+ readonly release_id?: number;
+ readonly commit_oid?: string;
+ readonly published_via_actions?: boolean;
+ readonly deleted_by_id?: number;
+ } | null;
+ readonly nuget_metadata?: {
+ readonly id?: number | string;
+ readonly name?: string;
+ readonly value?: boolean | string | number | {
+ readonly url?: string;
+ readonly branch?: string;
+ readonly commit?: string;
+ readonly type?: string;
+ };
+ }[] | null;
+ readonly package_files: {
+ readonly content_type: string;
+ readonly created_at: string;
/** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the repository */
+ readonly download_url: string;
readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
- /** Format: uri-template */
- readonly issues_url: string;
- /** Format: uri-template */
- readonly keys_url: string;
- /** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
- /** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /** Format: uri */
- readonly merges_url: string;
- /** Format: uri-template */
- readonly milestones_url: string;
- /** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
+ readonly md5: string | null;
readonly name: string;
- readonly node_id: string;
- /** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ readonly sha1: string | null;
+ readonly sha256: string | null;
+ readonly size: number;
+ readonly state: string | null;
+ readonly updated_at: string;
+ }[];
+ readonly package_url?: string;
+ readonly prerelease?: boolean;
+ readonly release?: {
/** User */
- readonly owner: {
+ readonly author: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -57222,146 +50291,61 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- };
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
- /** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
- /** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
- /** Format: uri */
- readonly subscription_url: string;
- /** Format: uri */
- readonly svn_url: string;
- /** Format: uri */
- readonly tags_url: string;
+ readonly created_at: string;
+ readonly draft: boolean;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
- /** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string | null;
+ readonly prerelease: boolean;
+ readonly published_at: string;
+ readonly tag_name: string;
+ readonly target_commitish: string;
/** Format: uri */
readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
};
- readonly sha: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
+ readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
+ readonly source_url?: string;
+ readonly summary: string;
+ readonly tag_name?: string;
+ readonly target_commitish?: string;
+ readonly target_oid?: string;
+ readonly updated_at?: string;
+ readonly version: string;
+ } | null;
+ readonly registry: {
+ /** Format: uri */
+ readonly about_url: string;
+ readonly name: string;
+ readonly type: string;
+ /** Format: uri */
+ readonly url: string;
+ readonly vendor: string;
+ } | null;
+ readonly updated_at: string | null;
+ };
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** package updated event */
+ readonly "webhook-package-updated": {
+ /** @enum {string} */
+ readonly action: "updated";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description Information about the package. */
+ readonly package: {
+ readonly created_at: string;
+ readonly description: string | null;
+ readonly ecosystem: string;
/** Format: uri */
readonly html_url: string;
readonly id: number;
- /** Format: uri */
- readonly issue_url: string;
- readonly labels: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- readonly locked: boolean;
- /** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
- /** Format: date-time */
- readonly merged_at: string | null;
+ readonly name: string;
+ readonly namespace: string;
/** User */
- readonly merged_by?: {
+ readonly owner: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -57393,22 +50377,14 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
+ readonly package_type: string;
+ readonly package_version: {
/** User */
- readonly creator: {
+ readonly author: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -57440,41 +50416,130 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
+ readonly body: string;
+ readonly body_html: string;
+ readonly created_at: string;
+ readonly description: string;
+ readonly docker_metadata?: {
+ readonly tags?: string[];
+ }[];
+ readonly draft?: boolean;
/** Format: uri */
readonly html_url: string;
readonly id: number;
+ readonly installation_command: string;
+ readonly manifest?: string;
+ readonly metadata: {
+ readonly [key: string]: unknown;
+ }[];
+ readonly name: string;
+ readonly package_files: {
+ readonly content_type: string;
+ readonly created_at: string;
+ /** Format: uri */
+ readonly download_url: string;
+ readonly id: number;
+ readonly md5: string | null;
+ readonly name: string;
+ readonly sha1: string | null;
+ readonly sha256: string;
+ readonly size: number;
+ readonly state: string;
+ readonly updated_at: string;
+ }[];
+ readonly package_url?: string;
+ readonly prerelease?: boolean;
+ readonly release?: {
+ /** User */
+ readonly author: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly created_at: string;
+ readonly draft: boolean;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string;
+ readonly prerelease: boolean;
+ readonly published_at: string;
+ readonly tag_name: string;
+ readonly target_commitish: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
+ readonly source_url?: string;
+ readonly summary: string;
+ readonly tag_name?: string;
+ readonly target_commitish: string;
+ readonly target_oid: string;
readonly updated_at: string;
+ readonly version: string;
+ };
+ readonly registry: {
+ /** Format: uri */
+ readonly about_url: string;
+ readonly name: string;
+ readonly type: string;
/** Format: uri */
readonly url: string;
+ readonly vendor: string;
} | null;
- readonly node_id: string;
- /** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
- /** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: (({
+ readonly updated_at: string;
+ };
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** page_build event */
+ readonly "webhook-page-build": {
+ /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */
+ readonly build: {
+ readonly commit: string | null;
+ readonly created_at: string;
+ readonly duration: number;
+ readonly error: {
+ readonly message: string | null;
+ };
+ /** User */
+ readonly pusher: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -57509,128 +50574,246 @@ export type components = {
readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null) | {
+ } | null;
+ readonly status: string;
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly id: number;
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** personal_access_token_request approved event */
+ readonly "webhook-personal-access-token-request-approved": {
+ /** @enum {string} */
+ readonly action: "approved";
+ readonly personal_access_token_request: components["schemas"]["personal-access-token-request"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly installation: components["schemas"]["simple-installation"];
+ };
+ /** personal_access_token_request cancelled event */
+ readonly "webhook-personal-access-token-request-cancelled": {
+ /** @enum {string} */
+ readonly action: "cancelled";
+ readonly personal_access_token_request: components["schemas"]["personal-access-token-request"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly installation: components["schemas"]["simple-installation"];
+ };
+ /** personal_access_token_request created event */
+ readonly "webhook-personal-access-token-request-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly personal_access_token_request: components["schemas"]["personal-access-token-request"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly installation: components["schemas"]["simple-installation"];
+ };
+ /** personal_access_token_request denied event */
+ readonly "webhook-personal-access-token-request-denied": {
+ /** @enum {string} */
+ readonly action: "denied";
+ readonly personal_access_token_request: components["schemas"]["personal-access-token-request"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly installation: components["schemas"]["simple-installation"];
+ };
+ readonly "webhook-ping": {
+ /**
+ * Webhook
+ * @description The webhook that is being pinged
+ */
+ readonly hook?: {
+ /** @description Determines whether the hook is actually triggered for the events it subscribes to. */
+ readonly active: boolean;
+ /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */
+ readonly app_id?: number;
+ readonly config: {
+ readonly content_type?: components["schemas"]["webhook-config-content-type"];
+ readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ readonly secret?: components["schemas"]["webhook-config-secret"];
+ readonly url?: components["schemas"]["webhook-config-url"];
+ };
+ /** Format: date-time */
+ readonly created_at: string;
+ /** Format: uri */
+ readonly deliveries_url?: string;
+ /** @description Determines what events the hook is triggered for. Default: ['push']. */
+ readonly events: string[];
+ /** @description Unique identifier of the webhook. */
+ readonly id: number;
+ readonly last_response?: components["schemas"]["hook-response"];
+ /**
+ * @description The type of webhook. The only valid value is 'web'.
+ * @enum {string}
+ */
+ readonly name: "web";
+ /** Format: uri */
+ readonly ping_url?: string;
+ /** Format: uri */
+ readonly test_url?: string;
+ readonly type: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** @description The ID of the webhook that triggered the ping. */
+ readonly hook_id?: number;
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ /** @description Random string of GitHub zen. */
+ readonly zen?: string;
+ };
+ /** @description The webhooks ping payload encoded with URL encoding. */
+ readonly "webhook-ping-form-encoded": {
+ /** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */
+ readonly payload: string;
+ };
+ /** project_card converted event */
+ readonly "webhook-project-card-converted": {
+ /** @enum {string} */
+ readonly action: "converted";
+ readonly changes: {
+ readonly note: {
+ readonly from: string;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly project_card: components["schemas"]["webhooks_project_card"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_card created event */
+ readonly "webhook-project-card-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly project_card: components["schemas"]["webhooks_project_card"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_card deleted event */
+ readonly "webhook-project-card-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project Card */
+ readonly project_card: {
+ readonly after_id?: number | null;
+ /** @description Whether or not the card is archived */
+ readonly archived: boolean;
+ readonly column_id: number | null;
+ /** Format: uri */
+ readonly column_url: string;
+ /** Format: uri */
+ readonly content_url?: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
readonly html_url?: string;
- /** @description Unique identifier of the team */
readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
+ readonly login: string;
+ readonly name?: string;
readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- })[];
- readonly requested_teams: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
+ readonly organizations_url?: string;
/** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
readonly url?: string;
- }[];
- /** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
- /** Format: uri */
- readonly review_comments_url: string;
- /**
- * @description State of this Pull Request. Either `open` or `closed`.
- * @enum {string}
- */
- readonly state: "open" | "closed";
+ } | null;
+ /** @description The project card's ID */
+ readonly id: number;
+ readonly node_id: string;
+ readonly note: string | null;
/** Format: uri */
- readonly statuses_url: string;
- /** @description The title of the pull request. */
- readonly title: string;
+ readonly project_url: string;
/** Format: date-time */
readonly updated_at: string;
/** Format: uri */
readonly url: string;
+ };
+ readonly repository?: components["schemas"]["nullable-repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_card edited event */
+ readonly "webhook-project-card-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ readonly changes: {
+ readonly note: {
+ readonly from: string | null;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly project_card: components["schemas"]["webhooks_project_card"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_card moved event */
+ readonly "webhook-project-card-moved": {
+ /** @enum {string} */
+ readonly action: "moved";
+ readonly changes?: {
+ readonly column_id: {
+ readonly from: number;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly project_card: {
+ readonly after_id?: number | null;
+ /** @description Whether or not the card is archived */
+ readonly archived: boolean;
+ readonly column_id: number;
+ /** Format: uri */
+ readonly column_url: string;
+ /** Format: uri */
+ readonly content_url?: string;
+ /** Format: date-time */
+ readonly created_at: string;
/** User */
- readonly user: {
+ readonly creator: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -57666,17 +50849,334 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
+ /** @description The project card's ID */
+ readonly id: number;
+ readonly node_id: string;
+ readonly note: string | null;
+ /** Format: uri */
+ readonly project_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } & {
+ readonly after_id: number | null;
+ readonly archived?: boolean;
+ readonly column_id?: number;
+ readonly column_url?: string;
+ readonly created_at?: string;
+ readonly creator?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ } | null;
+ readonly id?: number;
+ readonly node_id?: string;
+ readonly note?: string | null;
+ readonly project_url?: string;
+ readonly updated_at?: string;
+ readonly url?: string;
};
- readonly repository: components["schemas"]["repository-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project closed event */
+ readonly "webhook-project-closed": {
+ /** @enum {string} */
+ readonly action: "closed";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly project: components["schemas"]["webhooks_project"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_column created event */
+ readonly "webhook-project-column-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly project_column: components["schemas"]["webhooks_project_column"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
readonly sender?: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request dequeued event */
- readonly "webhook-pull-request-dequeued": {
+ /** project_column deleted event */
+ readonly "webhook-project-column-deleted": {
/** @enum {string} */
- readonly action: "dequeued";
+ readonly action: "deleted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly project_column: components["schemas"]["webhooks_project_column"];
+ readonly repository?: components["schemas"]["nullable-repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_column edited event */
+ readonly "webhook-project-column-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ readonly changes: {
+ readonly name?: {
+ readonly from: string;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly project_column: components["schemas"]["webhooks_project_column"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_column moved event */
+ readonly "webhook-project-column-moved": {
+ /** @enum {string} */
+ readonly action: "moved";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly project_column: components["schemas"]["webhooks_project_column"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project created event */
+ readonly "webhook-project-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly project: components["schemas"]["webhooks_project"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project deleted event */
+ readonly "webhook-project-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly project: components["schemas"]["webhooks_project"];
+ readonly repository?: components["schemas"]["nullable-repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project edited event */
+ readonly "webhook-project-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ /** @description The changes to the project if the action was `edited`. */
+ readonly changes?: {
+ readonly body?: {
+ /** @description The previous version of the body if the action was `edited`. */
+ readonly from: string;
+ };
+ readonly name?: {
+ /** @description The changes to the project if the action was `edited`. */
+ readonly from: string;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly project: components["schemas"]["webhooks_project"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project reopened event */
+ readonly "webhook-project-reopened": {
+ /** @enum {string} */
+ readonly action: "reopened";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly project: components["schemas"]["webhooks_project"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Project Closed Event */
+ readonly "webhook-projects-v2-project-closed": {
+ /** @enum {string} */
+ readonly action: "closed";
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly projects_v2: components["schemas"]["projects-v2"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** @description A project was created */
+ readonly "webhook-projects-v2-project-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly projects_v2: components["schemas"]["projects-v2"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Project Deleted Event */
+ readonly "webhook-projects-v2-project-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly projects_v2: components["schemas"]["projects-v2"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Project Edited Event */
+ readonly "webhook-projects-v2-project-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ readonly changes: {
+ readonly description?: {
+ readonly from?: string | null;
+ readonly to?: string | null;
+ };
+ readonly public?: {
+ readonly from?: boolean;
+ readonly to?: boolean;
+ };
+ readonly short_description?: {
+ readonly from?: string | null;
+ readonly to?: string | null;
+ };
+ readonly title?: {
+ readonly from?: string;
+ readonly to?: string;
+ };
+ };
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly projects_v2: components["schemas"]["projects-v2"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Item Archived Event */
+ readonly "webhook-projects-v2-item-archived": {
+ /** @enum {string} */
+ readonly action: "archived";
+ readonly changes: components["schemas"]["webhooks_project_changes"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly projects_v2_item: components["schemas"]["projects-v2-item"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Item Converted Event */
+ readonly "webhook-projects-v2-item-converted": {
+ /** @enum {string} */
+ readonly action: "converted";
+ readonly changes: {
+ readonly content_type?: {
+ readonly from?: string | null;
+ readonly to?: string;
+ };
+ };
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly projects_v2_item: components["schemas"]["projects-v2-item"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Item Created Event */
+ readonly "webhook-projects-v2-item-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly projects_v2_item: components["schemas"]["projects-v2-item"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Item Deleted Event */
+ readonly "webhook-projects-v2-item-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly projects_v2_item: components["schemas"]["projects-v2-item"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Item Edited Event */
+ readonly "webhook-projects-v2-item-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ readonly changes?: {
+ readonly field_value: {
+ readonly field_node_id?: string;
+ readonly field_type?: string;
+ };
+ } | {
+ readonly body: {
+ readonly from?: string | null;
+ readonly to?: string | null;
+ };
+ };
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly projects_v2_item: components["schemas"]["projects-v2-item"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Item Reordered Event */
+ readonly "webhook-projects-v2-item-reordered": {
+ /** @enum {string} */
+ readonly action: "reordered";
+ readonly changes: {
+ readonly previous_projects_v2_item_node_id?: {
+ readonly from?: string | null;
+ readonly to?: string | null;
+ };
+ };
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly projects_v2_item: components["schemas"]["projects-v2-item"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Item Restored Event */
+ readonly "webhook-projects-v2-item-restored": {
+ /** @enum {string} */
+ readonly action: "restored";
+ readonly changes: components["schemas"]["webhooks_project_changes"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly projects_v2_item: components["schemas"]["projects-v2-item"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Project Reopened Event */
+ readonly "webhook-projects-v2-project-reopened": {
+ /** @enum {string} */
+ readonly action: "reopened";
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly projects_v2: components["schemas"]["projects-v2"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** public event */
+ readonly "webhook-public": {
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly number: number;
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request assigned event */
+ readonly "webhook-pull-request-assigned": {
+ /** @enum {string} */
+ readonly action: "assigned";
+ readonly assignee: components["schemas"]["webhooks_user"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly number: components["schemas"]["webhooks_number"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
readonly pull_request: {
@@ -57758,7 +51258,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
@@ -57794,7 +51294,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -58197,7 +51697,7 @@ export type components = {
/** @description Indicates whether or not the pull request is a draft. */
readonly draft: boolean;
readonly head: {
- readonly label: string;
+ readonly label: string | null;
readonly ref: string;
/**
* Repository
@@ -58479,7 +51979,7 @@ export type components = {
readonly watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
readonly web_commit_signoff_required?: boolean;
- };
+ } | null;
readonly sha: string;
/** User */
readonly user: {
@@ -58694,22 +52194,22 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null) | {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ readonly description: string | null;
/** Format: uri */
- readonly html_url?: string;
+ readonly html_url: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ readonly members_url: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id?: string;
+ readonly node_id: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -58736,17 +52236,17 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ readonly permission: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ readonly privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ readonly repositories_url: string;
+ readonly slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ readonly url: string;
})[];
readonly requested_teams: {
readonly deleted?: boolean;
@@ -58855,94 +52355,13 @@ export type components = {
readonly url?: string;
} | null;
};
- readonly reason: string;
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request edited event */
- readonly "webhook-pull-request-edited": {
- /** @enum {string} */
- readonly action: "edited";
- /** @description The changes to the comment if the action was `edited`. */
- readonly changes: {
- readonly base?: {
- readonly ref: {
- readonly from: string;
- };
- readonly sha: {
- readonly from: string;
- };
- };
- readonly body?: {
- /** @description The previous version of the body if the action was `edited`. */
- readonly from: string;
- };
- readonly title?: {
- /** @description The previous version of the title if the action was `edited`. */
- readonly from: string;
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The pull request number. */
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["pull-request"] & {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow updating the pull request's branch. */
- readonly allow_update_branch?: boolean;
- /**
- * @description Whether to delete head branches when pull requests are merged.
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /**
- * @description The default value for a merge commit message.
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name").
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a squash merge commit message:
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** pull_request enqueued event */
- readonly "webhook-pull-request-enqueued": {
+ /** pull_request auto_merge_disabled event */
+ readonly "webhook-pull-request-auto-merge-disabled": {
/** @enum {string} */
- readonly action: "enqueued";
+ readonly action: "auto_merge_disabled";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
readonly number: number;
@@ -59224,6 +52643,11 @@ export type components = {
* @default true
*/
readonly has_issues: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ readonly has_discussions: boolean;
readonly has_pages: boolean;
/**
* @description Whether projects are enabled.
@@ -59235,11 +52659,6 @@ export type components = {
* @default true
*/
readonly has_wiki: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- */
- readonly has_discussions: boolean;
readonly homepage: string | null;
/** Format: uri */
readonly hooks_url: string;
@@ -59897,7 +53316,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -59963,22 +53382,22 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null) | {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ readonly description: string | null;
/** Format: uri */
- readonly html_url?: string;
+ readonly html_url: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ readonly members_url: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id?: string;
+ readonly node_id: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -60005,17 +53424,17 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ readonly permission: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ readonly privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ readonly repositories_url: string;
+ readonly slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ readonly url: string;
})[];
readonly requested_teams: {
readonly deleted?: boolean;
@@ -60124,32 +53543,16 @@ export type components = {
readonly url?: string;
} | null;
};
+ readonly reason: string;
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request labeled event */
- readonly "webhook-pull-request-labeled": {
+ /** pull_request auto_merge_enabled event */
+ readonly "webhook-pull-request-auto-merge-enabled": {
/** @enum {string} */
- readonly action: "labeled";
+ readonly action: "auto_merge_enabled";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** Label */
- readonly label?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
- /** @description The pull request number. */
readonly number: number;
readonly organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
@@ -60232,7 +53635,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -60268,7 +53671,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -60671,7 +54074,7 @@ export type components = {
/** @description Indicates whether or not the pull request is a draft. */
readonly draft: boolean;
readonly head: {
- readonly label: string | null;
+ readonly label: string;
readonly ref: string;
/**
* Repository
@@ -60953,7 +54356,7 @@ export type components = {
readonly watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
readonly web_commit_signoff_required?: boolean;
- } | null;
+ };
readonly sha: string;
/** User */
readonly user: {
@@ -61055,7 +54458,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -61329,16 +54732,52 @@ export type components = {
readonly url?: string;
} | null;
};
+ readonly reason?: string;
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request locked event */
- readonly "webhook-pull-request-locked": {
+ /** pull_request closed event */
+ readonly "webhook-pull-request-closed": {
/** @enum {string} */
- readonly action: "locked";
+ readonly action: "closed";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly number: components["schemas"]["webhooks_number"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly pull_request: components["schemas"]["pull-request-webhook"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request converted_to_draft event */
+ readonly "webhook-pull-request-converted-to-draft": {
+ /** @enum {string} */
+ readonly action: "converted_to_draft";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly number: components["schemas"]["webhooks_number"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly pull_request: components["schemas"]["pull-request-webhook"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request demilestoned event */
+ readonly "webhook-pull-request-demilestoned": {
+ /** @enum {string} */
+ readonly action: "demilestoned";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly milestone?: components["schemas"]["milestone"];
+ readonly number: components["schemas"]["webhooks_number"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly pull_request: components["schemas"]["webhooks_pull_request_5"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request dequeued event */
+ readonly "webhook-pull-request-dequeued": {
+ /** @enum {string} */
+ readonly action: "dequeued";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** @description The pull request number. */
readonly number: number;
readonly organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
@@ -61457,7 +54896,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -61860,7 +55299,7 @@ export type components = {
/** @description Indicates whether or not the pull request is a draft. */
readonly draft: boolean;
readonly head: {
- readonly label: string | null;
+ readonly label: string;
readonly ref: string;
/**
* Repository
@@ -62142,7 +55581,7 @@ export type components = {
readonly watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
readonly web_commit_signoff_required?: boolean;
- } | null;
+ };
readonly sha: string;
/** User */
readonly user: {
@@ -62244,7 +55683,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -62291,7 +55730,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
@@ -62357,22 +55796,22 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null) | {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ readonly description?: string | null;
/** Format: uri */
- readonly html_url: string;
+ readonly html_url?: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url: string;
+ readonly members_url?: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id: string;
+ readonly node_id?: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -62399,17 +55838,17 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ readonly permission?: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ readonly privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ readonly repositories_url?: string;
+ readonly slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ readonly url?: string;
})[];
readonly requested_teams: {
readonly deleted?: boolean;
@@ -62518,16 +55957,47 @@ export type components = {
readonly url?: string;
} | null;
};
+ readonly reason: string;
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request milestoned event */
- readonly "webhook-pull-request-milestoned": {
+ /** pull_request edited event */
+ readonly "webhook-pull-request-edited": {
/** @enum {string} */
- readonly action: "milestoned";
+ readonly action: "edited";
+ /** @description The changes to the comment if the action was `edited`. */
+ readonly changes: {
+ readonly base?: {
+ readonly ref: {
+ readonly from: string;
+ };
+ readonly sha: {
+ readonly from: string;
+ };
+ };
+ readonly body?: {
+ /** @description The previous version of the body if the action was `edited`. */
+ readonly from: string;
+ };
+ readonly title?: {
+ /** @description The previous version of the title if the action was `edited`. */
+ readonly from: string;
+ };
+ };
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly milestone?: components["schemas"]["milestone"];
- /** @description The pull request number. */
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly number: components["schemas"]["webhooks_number"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly pull_request: components["schemas"]["pull-request-webhook"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request enqueued event */
+ readonly "webhook-pull-request-enqueued": {
+ /** @enum {string} */
+ readonly action: "enqueued";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
readonly number: number;
readonly organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
@@ -62610,7 +56080,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -62646,7 +56116,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -62981,7 +56451,7 @@ export type components = {
/** Format: uri */
readonly url: string;
/**
- * @description Whether a squash merge commit can use the pull request title as default.
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
* @default false
*/
readonly use_squash_pr_title_as_default: boolean;
@@ -63321,7 +56791,7 @@ export type components = {
/** Format: uri */
readonly url: string;
/**
- * @description Whether a squash merge commit can use the pull request title as default.
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
* @default false
*/
readonly use_squash_pr_title_as_default: boolean;
@@ -63433,7 +56903,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -63549,502 +57019,177 @@ export type components = {
readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null) | {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- })[];
- readonly requested_teams: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- }[];
- /** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
- /** Format: uri */
- readonly review_comments_url: string;
- /**
- * @description State of this Pull Request. Either `open` or `closed`.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** Format: uri */
- readonly statuses_url: string;
- /** @description The title of the pull request. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** pull_request opened event */
- readonly "webhook-pull-request-opened": {
- /** @enum {string} */
- readonly action: "opened";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The pull request number. */
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["pull-request"] & {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow updating the pull request's branch. */
- readonly allow_update_branch?: boolean;
- /**
- * @description Whether to delete head branches when pull requests are merged.
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /**
- * @description The default value for a merge commit message.
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a squash merge commit message:
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** pull_request ready_for_review event */
- readonly "webhook-pull-request-ready-for-review": {
- /** @enum {string} */
- readonly action: "ready_for_review";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The pull request number. */
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["pull-request"] & {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow updating the pull request's branch. */
- readonly allow_update_branch?: boolean;
- /**
- * @description Whether to delete head branches when pull requests are merged.
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /**
- * @description The default value for a merge commit message.
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name").
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a squash merge commit message:
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** pull_request reopened event */
- readonly "webhook-pull-request-reopened": {
- /** @enum {string} */
- readonly action: "reopened";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The pull request number. */
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["pull-request"] & {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow updating the pull request's branch. */
- readonly allow_update_branch?: boolean;
- /**
- * @description Whether to delete head branches when pull requests are merged.
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /**
- * @description The default value for a merge commit message.
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name").
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a squash merge commit message:
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** pull_request_review_comment created event */
- readonly "webhook-pull-request-review-comment-created": {
- /** @enum {string} */
- readonly action: "created";
- /**
- * Pull Request Review Comment
- * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.
- */
- readonly comment: {
- readonly _links: {
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly pull_request: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly self: {
- /** Format: uri-template */
- readonly href: string;
- };
- };
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description The text of the comment. */
- readonly body: string;
- /** @description The SHA of the commit to which the comment applies. */
- readonly commit_id: string;
- /** Format: date-time */
- readonly created_at: string;
- /** @description The diff of the line that the comment refers to. */
- readonly diff_hunk: string;
- /**
- * Format: uri
- * @description HTML URL for the pull request review comment.
- */
- readonly html_url: string;
- /** @description The ID of the pull request review comment. */
- readonly id: number;
- /** @description The comment ID to reply to. */
- readonly in_reply_to_id?: number;
- /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly line: number | null;
- /** @description The node ID of the pull request review comment. */
- readonly node_id: string;
- /** @description The SHA of the original commit to which the comment applies. */
- readonly original_commit_id: string;
- /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly original_line: number | null;
- /** @description The index of the original line in the diff to which the comment applies. */
- readonly original_position: number;
- /** @description The first line of the range for a multi-line comment. */
- readonly original_start_line: number | null;
- /** @description The relative path of the file to which the comment applies. */
- readonly path: string;
- /** @description The line index in the diff to which the comment applies. */
- readonly position: number | null;
- /** @description The ID of the pull request review to which the comment belongs. */
- readonly pull_request_review_id: number | null;
- /**
- * Format: uri
- * @description URL for the pull request that the review comment belongs to.
- */
- readonly pull_request_url: string;
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /**
- * @description The side of the first line of the range for a multi-line comment.
- * @enum {string}
- */
- readonly side: "LEFT" | "RIGHT";
- /** @description The first line of the range for a multi-line comment. */
- readonly start_line: number | null;
- /**
- * @description The side of the first line of the range for a multi-line comment.
- * @default RIGHT
- * @enum {string|null}
- */
- readonly start_side: "LEFT" | "RIGHT" | null;
- /**
- * @description The level at which the comment is targeted, can be a diff line or a file.
- * @enum {string}
- */
- readonly subject_type?: "line" | "file";
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the pull request review comment
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
+ } | null) | {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
+ /** @enum {string} */
+ readonly privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url?: string;
+ })[];
+ readonly requested_teams: {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
+ /** @enum {string} */
+ readonly privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url?: string;
+ }[];
+ /** Format: uri-template */
+ readonly review_comment_url: string;
+ readonly review_comments?: number;
+ /** Format: uri */
+ readonly review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** Format: uri */
+ readonly statuses_url: string;
+ /** @description The title of the pull request. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
} | null;
};
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request labeled event */
+ readonly "webhook-pull-request-labeled": {
+ /** @enum {string} */
+ readonly action: "labeled";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
+ readonly label?: components["schemas"]["webhooks_label"];
+ readonly number: components["schemas"]["webhooks_number"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
readonly pull_request: {
readonly _links: {
/** Link */
@@ -64090,6 +57235,7 @@ export type components = {
};
/** @enum {string|null} */
readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly additions?: number;
/** User */
readonly assignee: {
/** Format: uri */
@@ -64173,7 +57319,7 @@ export type components = {
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge?: {
+ readonly auto_merge: {
/** @description Commit message for the merge commit. */
readonly commit_message: string | null;
/** @description Title for the merge commit message. */
@@ -64545,17 +57691,24 @@ export type components = {
} | null;
};
readonly body: string | null;
+ readonly changed_files?: number;
+ /** Format: date-time */
readonly closed_at: string | null;
+ readonly comments?: number;
/** Format: uri */
readonly comments_url: string;
+ readonly commits?: number;
/** Format: uri */
readonly commits_url: string;
+ /** Format: date-time */
readonly created_at: string;
+ readonly deletions?: number;
/** Format: uri */
readonly diff_url: string;
- readonly draft?: boolean;
+ /** @description Indicates whether or not the pull request is a draft. */
+ readonly draft: boolean;
readonly head: {
- readonly label: string;
+ readonly label: string | null;
readonly ref: string;
/**
* Repository
@@ -64898,8 +58051,51 @@ export type components = {
readonly url: string;
}[];
readonly locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ readonly maintainer_can_modify?: boolean;
readonly merge_commit_sha: string | null;
+ readonly mergeable?: boolean | null;
+ readonly mergeable_state?: string;
+ readonly merged?: boolean | null;
+ /** Format: date-time */
readonly merged_at: string | null;
+ /** User */
+ readonly merged_by?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
@@ -64972,9 +58168,11 @@ export type components = {
readonly url: string;
} | null;
readonly node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
readonly number: number;
/** Format: uri */
readonly patch_url: string;
+ readonly rebaseable?: boolean | null;
readonly requested_reviewers: (({
/** Format: uri */
readonly avatar_url?: string;
@@ -65114,13 +58312,19 @@ export type components = {
}[];
/** Format: uri-template */
readonly review_comment_url: string;
+ readonly review_comments?: number;
/** Format: uri */
readonly review_comments_url: string;
- /** @enum {string} */
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
readonly state: "open" | "closed";
/** Format: uri */
readonly statuses_url: string;
+ /** @description The title of the pull request. */
readonly title: string;
+ /** Format: date-time */
readonly updated_at: string;
/** Format: uri */
readonly url: string;
@@ -65165,158 +58369,15 @@ export type components = {
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request_review_comment deleted event */
- readonly "webhook-pull-request-review-comment-deleted": {
+ /** pull_request locked event */
+ readonly "webhook-pull-request-locked": {
/** @enum {string} */
- readonly action: "deleted";
- /**
- * Pull Request Review Comment
- * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.
- */
- readonly comment: {
- readonly _links: {
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly pull_request: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly self: {
- /** Format: uri-template */
- readonly href: string;
- };
- };
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description The text of the comment. */
- readonly body: string;
- /** @description The SHA of the commit to which the comment applies. */
- readonly commit_id: string;
- /** Format: date-time */
- readonly created_at: string;
- /** @description The diff of the line that the comment refers to. */
- readonly diff_hunk: string;
- /**
- * Format: uri
- * @description HTML URL for the pull request review comment.
- */
- readonly html_url: string;
- /** @description The ID of the pull request review comment. */
- readonly id: number;
- /** @description The comment ID to reply to. */
- readonly in_reply_to_id?: number;
- /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly line: number | null;
- /** @description The node ID of the pull request review comment. */
- readonly node_id: string;
- /** @description The SHA of the original commit to which the comment applies. */
- readonly original_commit_id: string;
- /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly original_line: number;
- /** @description The index of the original line in the diff to which the comment applies. */
- readonly original_position: number;
- /** @description The first line of the range for a multi-line comment. */
- readonly original_start_line: number | null;
- /** @description The relative path of the file to which the comment applies. */
- readonly path: string;
- /** @description The line index in the diff to which the comment applies. */
- readonly position: number | null;
- /** @description The ID of the pull request review to which the comment belongs. */
- readonly pull_request_review_id: number | null;
- /**
- * Format: uri
- * @description URL for the pull request that the review comment belongs to.
- */
- readonly pull_request_url: string;
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /**
- * @description The side of the first line of the range for a multi-line comment.
- * @enum {string}
- */
- readonly side: "LEFT" | "RIGHT";
- /** @description The first line of the range for a multi-line comment. */
- readonly start_line: number | null;
- /**
- * @description The side of the first line of the range for a multi-line comment.
- * @default RIGHT
- * @enum {string|null}
- */
- readonly start_side: "LEFT" | "RIGHT" | null;
- /**
- * @description The level at which the comment is targeted, can be a diff line or a file.
- * @enum {string}
- */
- readonly subject_type?: "line" | "file";
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the pull request review comment
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
+ readonly action: "locked";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
+ readonly number: components["schemas"]["webhooks_number"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
readonly pull_request: {
readonly _links: {
/** Link */
@@ -65362,6 +58423,7 @@ export type components = {
};
/** @enum {string|null} */
readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly additions?: number;
/** User */
readonly assignee: {
/** Format: uri */
@@ -65431,7 +58493,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -65445,7 +58507,7 @@ export type components = {
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge?: {
+ readonly auto_merge: {
/** @description Commit message for the merge commit. */
readonly commit_message: string | null;
/** @description Title for the merge commit message. */
@@ -65817,17 +58879,24 @@ export type components = {
} | null;
};
readonly body: string | null;
+ readonly changed_files?: number;
+ /** Format: date-time */
readonly closed_at: string | null;
+ readonly comments?: number;
/** Format: uri */
readonly comments_url: string;
+ readonly commits?: number;
/** Format: uri */
readonly commits_url: string;
+ /** Format: date-time */
readonly created_at: string;
+ readonly deletions?: number;
/** Format: uri */
readonly diff_url: string;
- readonly draft?: boolean;
+ /** @description Indicates whether or not the pull request is a draft. */
+ readonly draft: boolean;
readonly head: {
- readonly label: string;
+ readonly label: string | null;
readonly ref: string;
/**
* Repository
@@ -66170,8 +59239,51 @@ export type components = {
readonly url: string;
}[];
readonly locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ readonly maintainer_can_modify?: boolean;
readonly merge_commit_sha: string | null;
+ readonly mergeable?: boolean | null;
+ readonly mergeable_state?: string;
+ readonly merged?: boolean | null;
+ /** Format: date-time */
readonly merged_at: string | null;
+ /** User */
+ readonly merged_by?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
@@ -66244,9 +59356,11 @@ export type components = {
readonly url: string;
} | null;
readonly node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
readonly number: number;
/** Format: uri */
readonly patch_url: string;
+ readonly rebaseable?: boolean | null;
readonly requested_reviewers: (({
/** Format: uri */
readonly avatar_url?: string;
@@ -66279,22 +59393,22 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null) | {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ readonly description: string | null;
/** Format: uri */
- readonly html_url?: string;
+ readonly html_url: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ readonly members_url: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id?: string;
+ readonly node_id: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -66321,17 +59435,17 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ readonly permission: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ readonly privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ readonly repositories_url: string;
+ readonly slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ readonly url: string;
})[];
readonly requested_teams: {
readonly deleted?: boolean;
@@ -66386,13 +59500,19 @@ export type components = {
}[];
/** Format: uri-template */
readonly review_comment_url: string;
+ readonly review_comments?: number;
/** Format: uri */
readonly review_comments_url: string;
- /** @enum {string} */
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
readonly state: "open" | "closed";
/** Format: uri */
readonly statuses_url: string;
+ /** @description The title of the pull request. */
readonly title: string;
+ /** Format: date-time */
readonly updated_at: string;
/** Format: uri */
readonly url: string;
@@ -66437,17 +59557,58 @@ export type components = {
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request_review_comment edited event */
- readonly "webhook-pull-request-review-comment-edited": {
+ /** pull_request milestoned event */
+ readonly "webhook-pull-request-milestoned": {
/** @enum {string} */
- readonly action: "edited";
- /** @description The changes to the comment. */
- readonly changes: {
- readonly body?: {
- /** @description The previous version of the body. */
- readonly from: string;
- };
- };
+ readonly action: "milestoned";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly milestone?: components["schemas"]["milestone"];
+ readonly number: components["schemas"]["webhooks_number"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly pull_request: components["schemas"]["webhooks_pull_request_5"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request opened event */
+ readonly "webhook-pull-request-opened": {
+ /** @enum {string} */
+ readonly action: "opened";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly number: components["schemas"]["webhooks_number"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly pull_request: components["schemas"]["pull-request-webhook"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request ready_for_review event */
+ readonly "webhook-pull-request-ready-for-review": {
+ /** @enum {string} */
+ readonly action: "ready_for_review";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly number: components["schemas"]["webhooks_number"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly pull_request: components["schemas"]["pull-request-webhook"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request reopened event */
+ readonly "webhook-pull-request-reopened": {
+ /** @enum {string} */
+ readonly action: "reopened";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly number: components["schemas"]["webhooks_number"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly pull_request: components["schemas"]["pull-request-webhook"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request_review_comment created event */
+ readonly "webhook-pull-request-review-comment-created": {
+ /** @enum {string} */
+ readonly action: "created";
/**
* Pull Request Review Comment
* @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.
@@ -66500,7 +59661,7 @@ export type components = {
/** @description The SHA of the original commit to which the comment applies. */
readonly original_commit_id: string;
/** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly original_line: number;
+ readonly original_line: number | null;
/** @description The index of the original line in the diff to which the comment applies. */
readonly original_position: number;
/** @description The first line of the range for a multi-line comment. */
@@ -66674,7 +59835,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
@@ -66710,7 +59871,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -67558,22 +60719,22 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null) | {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ readonly description: string | null;
/** Format: uri */
- readonly html_url?: string;
+ readonly html_url: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ readonly members_url: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id?: string;
+ readonly node_id: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -67600,17 +60761,17 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ readonly permission: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ readonly privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ readonly repositories_url: string;
+ readonly slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ readonly url: string;
})[];
readonly requested_teams: {
readonly deleted?: boolean;
@@ -67712,100 +60873,100 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** pull_request_review dismissed event */
- readonly "webhook-pull-request-review-dismissed": {
- /** @enum {string} */
- readonly action: "dismissed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Simple Pull Request */
- readonly pull_request: {
- readonly _links: {
- /** Link */
- readonly comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly commits: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly issue: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comment: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly self: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly statuses: {
- /** Format: uri-template */
- readonly href: string;
- };
- };
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
+ };
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request_review_comment deleted event */
+ readonly "webhook-pull-request-review-comment-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly comment: components["schemas"]["webhooks_review_comment"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly pull_request: {
+ readonly _links: {
+ /** Link */
+ readonly comments: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly commits: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly html: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly issue: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comment: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comments: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly self: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly statuses: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ };
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ /** User */
+ readonly assignee: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
readonly assignees: ({
/** Format: uri */
readonly avatar_url?: string;
@@ -67838,7 +60999,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -67852,7 +61013,7 @@ export type components = {
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ readonly auto_merge?: {
/** @description Commit message for the merge commit. */
readonly commit_message: string | null;
/** @description Title for the merge commit message. */
@@ -68232,7 +61393,7 @@ export type components = {
readonly created_at: string;
/** Format: uri */
readonly diff_url: string;
- readonly draft: boolean;
+ readonly draft?: boolean;
readonly head: {
readonly label: string;
readonly ref: string;
@@ -68686,22 +61847,22 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null) | {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ readonly description?: string | null;
/** Format: uri */
- readonly html_url: string;
+ readonly html_url?: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url: string;
+ readonly members_url?: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id: string;
+ readonly node_id?: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -68728,17 +61889,17 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ readonly permission?: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ readonly privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ readonly repositories_url?: string;
+ readonly slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ readonly url?: string;
})[];
readonly requested_teams: {
readonly deleted?: boolean;
@@ -68842,95 +62003,17 @@ export type components = {
} | null;
};
readonly repository: components["schemas"]["repository-webhooks"];
- /** @description The review that was affected. */
- readonly review: {
- readonly _links: {
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly pull_request: {
- /** Format: uri-template */
- readonly href: string;
- };
- };
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description The text of the review. */
- readonly body: string | null;
- /** @description A commit SHA for the review. */
- readonly commit_id: string;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the review */
- readonly id: number;
- readonly node_id: string;
- /** Format: uri */
- readonly pull_request_url: string;
- /** @enum {string} */
- readonly state: "dismissed" | "approved" | "changes_requested";
- /** Format: date-time */
- readonly submitted_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request_review edited event */
- readonly "webhook-pull-request-review-edited": {
+ /** pull_request_review_comment edited event */
+ readonly "webhook-pull-request-review-comment-edited": {
/** @enum {string} */
readonly action: "edited";
- readonly changes: {
- readonly body?: {
- /** @description The previous version of the body if the action was `edited`. */
- readonly from: string;
- };
- };
+ readonly changes: components["schemas"]["webhooks_changes"];
+ readonly comment: components["schemas"]["webhooks_review_comment"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Simple Pull Request */
readonly pull_request: {
readonly _links: {
/** Link */
@@ -69009,7 +62092,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -69045,7 +62128,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -69059,7 +62142,7 @@ export type components = {
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ readonly auto_merge?: {
/** @description Commit message for the merge commit. */
readonly commit_message: string | null;
/** @description Title for the merge commit message. */
@@ -69217,6 +62300,11 @@ export type components = {
* @default true
*/
readonly has_wiki: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ readonly has_discussions: boolean;
readonly homepage: string | null;
/** Format: uri */
readonly hooks_url: string;
@@ -69248,6 +62336,23 @@ export type components = {
readonly url: string | null;
} | null;
readonly master_branch?: string;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
readonly merges_url: string;
/** Format: uri-template */
@@ -69316,6 +62421,23 @@ export type components = {
readonly releases_url: string;
readonly role_name?: string | null;
readonly size: number;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
readonly ssh_url: string;
readonly stargazers?: number;
readonly stargazers_count: number;
@@ -69340,10 +62462,17 @@ export type components = {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
/** @enum {string} */
readonly visibility: "public" | "private" | "internal";
readonly watchers: number;
readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
};
readonly sha: string;
/** User */
@@ -69393,7 +62522,7 @@ export type components = {
readonly created_at: string;
/** Format: uri */
readonly diff_url: string;
- readonly draft: boolean;
+ readonly draft?: boolean;
readonly head: {
readonly label: string;
readonly ref: string;
@@ -69504,6 +62633,11 @@ export type components = {
* @default true
*/
readonly has_wiki: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ readonly has_discussions: boolean;
readonly homepage: string | null;
/** Format: uri */
readonly hooks_url: string;
@@ -69535,6 +62669,23 @@ export type components = {
readonly url: string | null;
} | null;
readonly master_branch?: string;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
readonly merges_url: string;
/** Format: uri-template */
@@ -69603,6 +62754,23 @@ export type components = {
readonly releases_url: string;
readonly role_name?: string | null;
readonly size: number;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
readonly ssh_url: string;
readonly stargazers?: number;
readonly stargazers_count: number;
@@ -69627,10 +62795,17 @@ export type components = {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
/** @enum {string} */
readonly visibility: "public" | "private" | "internal";
readonly watchers: number;
readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
} | null;
readonly sha: string;
/** User */
@@ -69801,22 +62976,22 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null) | {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ readonly description?: string | null;
/** Format: uri */
- readonly html_url: string;
+ readonly html_url?: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url: string;
+ readonly members_url?: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id: string;
+ readonly node_id?: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -69843,17 +63018,17 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ readonly permission?: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ readonly privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ readonly repositories_url?: string;
+ readonly slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ readonly url?: string;
})[];
readonly requested_teams: {
readonly deleted?: boolean;
@@ -69957,90 +63132,16 @@ export type components = {
} | null;
};
readonly repository: components["schemas"]["repository-webhooks"];
- /** @description The review that was affected. */
- readonly review: {
- readonly _links: {
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly pull_request: {
- /** Format: uri-template */
- readonly href: string;
- };
- };
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description The text of the review. */
- readonly body: string | null;
- /** @description A commit SHA for the review. */
- readonly commit_id: string;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the review */
- readonly id: number;
- readonly node_id: string;
- /** Format: uri */
- readonly pull_request_url: string;
- readonly state: string;
- /** Format: date-time */
- readonly submitted_at: string | null;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request review_request_removed event */
- readonly "webhook-pull-request-review-request-removed": {
+ /** pull_request_review dismissed event */
+ readonly "webhook-pull-request-review-dismissed": {
/** @enum {string} */
- readonly action: "review_request_removed";
+ readonly action: "dismissed";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** @description The pull request number. */
- readonly number: number;
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Pull Request */
+ /** Simple Pull Request */
readonly pull_request: {
readonly _links: {
/** Link */
@@ -70086,7 +63187,6 @@ export type components = {
};
/** @enum {string|null} */
readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
/** User */
readonly assignee: {
/** Format: uri */
@@ -70120,7 +63220,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
@@ -70156,7 +63256,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -70450,12 +63550,19 @@ export type components = {
readonly role_name?: string | null;
readonly size: number;
/**
- * @description The default value for a squash merge commit message.
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
* @enum {string}
*/
readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
- * @description The default value for a squash merge commit title.
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
* @enum {string}
*/
readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
@@ -70535,21 +63642,14 @@ export type components = {
} | null;
};
readonly body: string | null;
- readonly changed_files?: number;
- /** Format: date-time */
readonly closed_at: string | null;
- readonly comments?: number;
/** Format: uri */
readonly comments_url: string;
- readonly commits?: number;
/** Format: uri */
readonly commits_url: string;
- /** Format: date-time */
readonly created_at: string;
- readonly deletions?: number;
/** Format: uri */
readonly diff_url: string;
- /** @description Indicates whether or not the pull request is a draft. */
readonly draft: boolean;
readonly head: {
readonly label: string;
@@ -70834,7 +63934,7 @@ export type components = {
readonly watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
readonly web_commit_signoff_required?: boolean;
- };
+ } | null;
readonly sha: string;
/** User */
readonly user: {
@@ -70895,51 +63995,8 @@ export type components = {
readonly url: string;
}[];
readonly locked: boolean;
- /** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
- /** Format: date-time */
readonly merged_at: string | null;
- /** User */
- readonly merged_by?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
@@ -71012,11 +64069,9 @@ export type components = {
readonly url: string;
} | null;
readonly node_id: string;
- /** @description Number uniquely identifying the pull request within its repository. */
readonly number: number;
/** Format: uri */
readonly patch_url: string;
- readonly rebaseable?: boolean | null;
readonly requested_reviewers: (({
/** Format: uri */
readonly avatar_url?: string;
@@ -71049,7 +64104,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null) | {
@@ -71102,73 +64157,67 @@ export type components = {
* @description URL for the team
*/
readonly url: string;
- })[];
- readonly requested_teams: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
+ })[];
+ readonly requested_teams: {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
+ /** @enum {string} */
+ readonly privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url?: string;
}[];
/** Format: uri-template */
readonly review_comment_url: string;
- readonly review_comments?: number;
/** Format: uri */
readonly review_comments_url: string;
- /**
- * @description State of this Pull Request. Either `open` or `closed`.
- * @enum {string}
- */
+ /** @enum {string} */
readonly state: "open" | "closed";
/** Format: uri */
readonly statuses_url: string;
- /** @description The title of the pull request. */
readonly title: string;
- /** Format: date-time */
readonly updated_at: string;
/** Format: uri */
readonly url: string;
@@ -71205,59 +64254,101 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
};
readonly repository: components["schemas"]["repository-webhooks"];
- /** User */
- readonly requested_reviewer: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ /** @description The review that was affected. */
+ readonly review: {
+ readonly _links: {
+ /** Link */
+ readonly html: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly pull_request: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description The text of the review. */
+ readonly body: string | null;
+ /** @description A commit SHA for the review. */
+ readonly commit_id: string;
/** Format: uri */
- readonly html_url?: string;
+ readonly html_url: string;
+ /** @description Unique identifier of the review */
readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
+ readonly node_id: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ readonly pull_request_url: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
+ readonly state: "dismissed" | "approved" | "changes_requested";
+ /** Format: date-time */
+ readonly submitted_at: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
readonly sender: components["schemas"]["simple-user-webhooks"];
- } | {
+ };
+ /** pull_request_review edited event */
+ readonly "webhook-pull-request-review-edited": {
/** @enum {string} */
- readonly action: "review_request_removed";
+ readonly action: "edited";
+ readonly changes: {
+ readonly body?: {
+ /** @description The previous version of the body if the action was `edited`. */
+ readonly from: string;
+ };
+ };
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** @description The pull request number. */
- readonly number: number;
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Pull Request */
+ /** Simple Pull Request */
readonly pull_request: {
readonly _links: {
/** Link */
@@ -71303,7 +64394,6 @@ export type components = {
};
/** @enum {string|null} */
readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
/** User */
readonly assignee: {
/** Format: uri */
@@ -71337,7 +64427,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
@@ -71373,7 +64463,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -71545,11 +64635,6 @@ export type components = {
* @default true
*/
readonly has_wiki: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- */
- readonly has_discussions: boolean;
readonly homepage: string | null;
/** Format: uri */
readonly hooks_url: string;
@@ -71581,23 +64666,6 @@ export type components = {
readonly url: string | null;
} | null;
readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
readonly merges_url: string;
/** Format: uri-template */
@@ -71666,23 +64734,6 @@ export type components = {
readonly releases_url: string;
readonly role_name?: string | null;
readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
readonly ssh_url: string;
readonly stargazers?: number;
readonly stargazers_count: number;
@@ -71707,17 +64758,10 @@ export type components = {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
/** @enum {string} */
readonly visibility: "public" | "private" | "internal";
readonly watchers: number;
readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
};
readonly sha: string;
/** User */
@@ -71759,21 +64803,14 @@ export type components = {
} | null;
};
readonly body: string | null;
- readonly changed_files?: number;
- /** Format: date-time */
readonly closed_at: string | null;
- readonly comments?: number;
/** Format: uri */
readonly comments_url: string;
- readonly commits?: number;
/** Format: uri */
readonly commits_url: string;
- /** Format: date-time */
readonly created_at: string;
- readonly deletions?: number;
/** Format: uri */
readonly diff_url: string;
- /** @description Indicates whether or not the pull request is a draft. */
readonly draft: boolean;
readonly head: {
readonly label: string;
@@ -71885,11 +64922,6 @@ export type components = {
* @default true
*/
readonly has_wiki: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- */
- readonly has_discussions: boolean;
readonly homepage: string | null;
/** Format: uri */
readonly hooks_url: string;
@@ -71921,23 +64953,6 @@ export type components = {
readonly url: string | null;
} | null;
readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
readonly merges_url: string;
/** Format: uri-template */
@@ -72006,23 +65021,6 @@ export type components = {
readonly releases_url: string;
readonly role_name?: string | null;
readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
readonly ssh_url: string;
readonly stargazers?: number;
readonly stargazers_count: number;
@@ -72047,18 +65045,11 @@ export type components = {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
/** @enum {string} */
readonly visibility: "public" | "private" | "internal";
readonly watchers: number;
readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
- };
+ } | null;
readonly sha: string;
/** User */
readonly user: {
@@ -72119,51 +65110,8 @@ export type components = {
readonly url: string;
}[];
readonly locked: boolean;
- /** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
- /** Format: date-time */
readonly merged_at: string | null;
- /** User */
- readonly merged_by?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
@@ -72207,7 +65155,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
@@ -72236,11 +65184,9 @@ export type components = {
readonly url: string;
} | null;
readonly node_id: string;
- /** @description Number uniquely identifying the pull request within its repository. */
readonly number: number;
/** Format: uri */
readonly patch_url: string;
- readonly rebaseable?: boolean | null;
readonly requested_reviewers: (({
/** Format: uri */
readonly avatar_url?: string;
@@ -72273,7 +65219,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null) | {
@@ -72330,16 +65276,16 @@ export type components = {
readonly requested_teams: {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ readonly description?: string | null;
/** Format: uri */
- readonly html_url: string;
+ readonly html_url?: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url: string;
+ readonly members_url?: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id: string;
+ readonly node_id?: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -72366,33 +65312,27 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ readonly permission?: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ readonly privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ readonly repositories_url?: string;
+ readonly slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ readonly url?: string;
}[];
/** Format: uri-template */
readonly review_comment_url: string;
- readonly review_comments?: number;
/** Format: uri */
readonly review_comments_url: string;
- /**
- * @description State of this Pull Request. Either `open` or `closed`.
- * @enum {string}
- */
+ /** @enum {string} */
readonly state: "open" | "closed";
/** Format: uri */
readonly statuses_url: string;
- /** @description The title of the pull request. */
readonly title: string;
- /** Format: date-time */
readonly updated_at: string;
/** Format: uri */
readonly url: string;
@@ -72429,73 +65369,19 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
};
readonly repository: components["schemas"]["repository-webhooks"];
- /**
- * Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly requested_team: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- };
+ readonly review: components["schemas"]["webhooks_review"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request review_requested event */
- readonly "webhook-pull-request-review-requested": {
+ /** pull_request review_request_removed event */
+ readonly "webhook-pull-request-review-request-removed": {
/** @enum {string} */
- readonly action: "review_requested";
+ readonly action: "review_request_removed";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
@@ -72581,7 +65467,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -72617,7 +65503,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -72911,19 +65797,12 @@ export type components = {
readonly role_name?: string | null;
readonly size: number;
/**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
+ * @description The default value for a squash merge commit message.
* @enum {string}
*/
readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @description The default value for a squash merge commit title.
* @enum {string}
*/
readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
@@ -73451,7 +66330,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -73574,16 +66453,16 @@ export type components = {
readonly requested_teams: {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ readonly description: string | null;
/** Format: uri */
- readonly html_url?: string;
+ readonly html_url: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ readonly members_url: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id?: string;
+ readonly node_id: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -73610,17 +66489,17 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ readonly permission: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ readonly privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ readonly repositories_url: string;
+ readonly slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ readonly url: string;
}[];
/** Format: uri-template */
readonly review_comment_url: string;
@@ -73673,7 +66552,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -73712,14 +66591,14 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
readonly sender: components["schemas"]["simple-user-webhooks"];
} | {
/** @enum {string} */
- readonly action: "review_requested";
+ readonly action: "review_request_removed";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
@@ -73805,7 +66684,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -73841,7 +66720,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -74675,7 +67554,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -74747,16 +67626,16 @@ export type components = {
} | null) | {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ readonly description: string | null;
/** Format: uri */
- readonly html_url?: string;
+ readonly html_url: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ readonly members_url: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id?: string;
+ readonly node_id: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -74783,31 +67662,31 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ readonly permission: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ readonly privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ readonly repositories_url: string;
+ readonly slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ readonly url: string;
})[];
readonly requested_teams: {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ readonly description: string | null;
/** Format: uri */
- readonly html_url?: string;
+ readonly html_url: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ readonly members_url: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id?: string;
+ readonly node_id: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -74834,17 +67713,17 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ readonly permission: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ readonly privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ readonly repositories_url: string;
+ readonly slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ readonly url: string;
}[];
/** Format: uri-template */
readonly review_comment_url: string;
@@ -74897,7 +67776,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -74910,16 +67789,16 @@ export type components = {
readonly requested_team: {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ readonly description: string | null;
/** Format: uri */
- readonly html_url?: string;
+ readonly html_url: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ readonly members_url: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id?: string;
+ readonly node_id: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -74946,28 +67825,30 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ readonly permission: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ readonly privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ readonly repositories_url: string;
+ readonly slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ readonly url: string;
};
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request_review submitted event */
- readonly "webhook-pull-request-review-submitted": {
+ /** pull_request review_requested event */
+ readonly "webhook-pull-request-review-requested": {
/** @enum {string} */
- readonly action: "submitted";
+ readonly action: "review_requested";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ readonly number: number;
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Simple Pull Request */
+ /** Pull Request */
readonly pull_request: {
readonly _links: {
/** Link */
@@ -75013,6 +67894,7 @@ export type components = {
};
/** @enum {string|null} */
readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly additions?: number;
/** User */
readonly assignee: {
/** Format: uri */
@@ -75468,17 +68350,24 @@ export type components = {
} | null;
};
readonly body: string | null;
+ readonly changed_files?: number;
+ /** Format: date-time */
readonly closed_at: string | null;
+ readonly comments?: number;
/** Format: uri */
readonly comments_url: string;
+ readonly commits?: number;
/** Format: uri */
readonly commits_url: string;
+ /** Format: date-time */
readonly created_at: string;
+ readonly deletions?: number;
/** Format: uri */
readonly diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
readonly draft: boolean;
readonly head: {
- readonly label: string | null;
+ readonly label: string;
readonly ref: string;
/**
* Repository
@@ -75760,7 +68649,7 @@ export type components = {
readonly watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
readonly web_commit_signoff_required?: boolean;
- } | null;
+ };
readonly sha: string;
/** User */
readonly user: {
@@ -75821,8 +68710,51 @@ export type components = {
readonly url: string;
}[];
readonly locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ readonly maintainer_can_modify?: boolean;
readonly merge_commit_sha: string | null;
+ readonly mergeable?: boolean | null;
+ readonly mergeable_state?: string;
+ readonly merged?: boolean | null;
+ /** Format: date-time */
readonly merged_at: string | null;
+ /** User */
+ readonly merged_by?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
@@ -75895,9 +68827,11 @@ export type components = {
readonly url: string;
} | null;
readonly node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
readonly number: number;
/** Format: uri */
readonly patch_url: string;
+ readonly rebaseable?: boolean | null;
readonly requested_reviewers: (({
/** Format: uri */
readonly avatar_url?: string;
@@ -75930,7 +68864,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null) | {
@@ -76037,13 +68971,19 @@ export type components = {
}[];
/** Format: uri-template */
readonly review_comment_url: string;
+ readonly review_comments?: number;
/** Format: uri */
readonly review_comments_url: string;
- /** @enum {string} */
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
readonly state: "open" | "closed";
/** Format: uri */
readonly statuses_url: string;
+ /** @description The title of the pull request. */
readonly title: string;
+ /** Format: date-time */
readonly updated_at: string;
/** Format: uri */
readonly url: string;
@@ -76086,88 +69026,53 @@ export type components = {
} | null;
};
readonly repository: components["schemas"]["repository-webhooks"];
- /** @description The review that was affected. */
- readonly review: {
- readonly _links: {
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly pull_request: {
- /** Format: uri-template */
- readonly href: string;
- };
- };
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description The text of the review. */
- readonly body: string | null;
- /** @description A commit SHA for the review. */
- readonly commit_id: string;
+ /** User */
+ readonly requested_reviewer: {
/** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the review */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
- readonly node_id: string;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly pull_request_url: string;
- readonly state: string;
- /** Format: date-time */
- readonly submitted_at: string | null;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** pull_request_review_thread resolved event */
- readonly "webhook-pull-request-review-thread-resolved": {
+ } | {
/** @enum {string} */
- readonly action: "resolved";
+ readonly action: "review_requested";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ readonly number: number;
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Simple Pull Request */
+ /** Pull Request */
readonly pull_request: {
readonly _links: {
/** Link */
@@ -76213,6 +69118,7 @@ export type components = {
};
/** @enum {string|null} */
readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly additions?: number;
/** User */
readonly assignee: {
/** Format: uri */
@@ -76246,7 +69152,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
@@ -76282,7 +69188,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -76490,6 +69396,23 @@ export type components = {
readonly url: string | null;
} | null;
readonly master_branch?: string;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
readonly merges_url: string;
/** Format: uri-template */
@@ -76558,6 +69481,23 @@ export type components = {
readonly releases_url: string;
readonly role_name?: string | null;
readonly size: number;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
readonly ssh_url: string;
readonly stargazers?: number;
readonly stargazers_count: number;
@@ -76582,6 +69522,11 @@ export type components = {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
/** @enum {string} */
readonly visibility: "public" | "private" | "internal";
readonly watchers: number;
@@ -76629,17 +69574,24 @@ export type components = {
} | null;
};
readonly body: string | null;
+ readonly changed_files?: number;
+ /** Format: date-time */
readonly closed_at: string | null;
+ readonly comments?: number;
/** Format: uri */
readonly comments_url: string;
+ readonly commits?: number;
/** Format: uri */
readonly commits_url: string;
+ /** Format: date-time */
readonly created_at: string;
+ readonly deletions?: number;
/** Format: uri */
readonly diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
readonly draft: boolean;
readonly head: {
- readonly label: string | null;
+ readonly label: string;
readonly ref: string;
/**
* Repository
@@ -76784,6 +69736,23 @@ export type components = {
readonly url: string | null;
} | null;
readonly master_branch?: string;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
readonly merges_url: string;
/** Format: uri-template */
@@ -76852,6 +69821,23 @@ export type components = {
readonly releases_url: string;
readonly role_name?: string | null;
readonly size: number;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
readonly ssh_url: string;
readonly stargazers?: number;
readonly stargazers_count: number;
@@ -76876,13 +69862,18 @@ export type components = {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
/** @enum {string} */
readonly visibility: "public" | "private" | "internal";
readonly watchers: number;
readonly watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
readonly web_commit_signoff_required?: boolean;
- } | null;
+ };
readonly sha: string;
/** User */
readonly user: {
@@ -76943,8 +69934,51 @@ export type components = {
readonly url: string;
}[];
readonly locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ readonly maintainer_can_modify?: boolean;
readonly merge_commit_sha: string | null;
+ readonly mergeable?: boolean | null;
+ readonly mergeable_state?: string;
+ readonly merged?: boolean | null;
+ /** Format: date-time */
readonly merged_at: string | null;
+ /** User */
+ readonly merged_by?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
@@ -76988,7 +70022,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
@@ -77017,9 +70051,11 @@ export type components = {
readonly url: string;
} | null;
readonly node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
readonly number: number;
/** Format: uri */
readonly patch_url: string;
+ readonly rebaseable?: boolean | null;
readonly requested_reviewers: (({
/** Format: uri */
readonly avatar_url?: string;
@@ -77052,22 +70088,22 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null) | {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ readonly description?: string | null;
/** Format: uri */
- readonly html_url: string;
+ readonly html_url?: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url: string;
+ readonly members_url?: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id: string;
+ readonly node_id?: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -77094,17 +70130,17 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ readonly permission?: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ readonly privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ readonly repositories_url?: string;
+ readonly slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ readonly url?: string;
})[];
readonly requested_teams: {
readonly deleted?: boolean;
@@ -77159,13 +70195,19 @@ export type components = {
}[];
/** Format: uri-template */
readonly review_comment_url: string;
+ readonly review_comments?: number;
/** Format: uri */
readonly review_comments_url: string;
- /** @enum {string} */
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
readonly state: "open" | "closed";
/** Format: uri */
readonly statuses_url: string;
+ /** @description The title of the pull request. */
readonly title: string;
+ /** Format: date-time */
readonly updated_at: string;
/** Format: uri */
readonly url: string;
@@ -77208,156 +70250,67 @@ export type components = {
} | null;
};
readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- readonly thread: {
- readonly comments: {
- readonly _links: {
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly pull_request: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly self: {
- /** Format: uri-template */
- readonly href: string;
- };
- };
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description The text of the comment. */
- readonly body: string;
- /** @description The SHA of the commit to which the comment applies. */
- readonly commit_id: string;
- /** Format: date-time */
- readonly created_at: string;
- /** @description The diff of the line that the comment refers to. */
- readonly diff_hunk: string;
- /**
- * Format: uri
- * @description HTML URL for the pull request review comment.
- */
+ /**
+ * Team
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ readonly requested_team: {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
readonly html_url: string;
- /** @description The ID of the pull request review comment. */
+ /** @description Unique identifier of the team */
readonly id: number;
- /** @description The comment ID to reply to. */
- readonly in_reply_to_id?: number;
- /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly line: number | null;
- /** @description The node ID of the pull request review comment. */
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
readonly node_id: string;
- /** @description The SHA of the original commit to which the comment applies. */
- readonly original_commit_id: string;
- /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly original_line: number | null;
- /** @description The index of the original line in the diff to which the comment applies. */
- readonly original_position: number;
- /** @description The first line of the range for a multi-line comment. */
- readonly original_start_line: number | null;
- /** @description The relative path of the file to which the comment applies. */
- readonly path: string;
- /** @description The line index in the diff to which the comment applies. */
- readonly position: number | null;
- /** @description The ID of the pull request review to which the comment belongs. */
- readonly pull_request_review_id: number | null;
- /**
- * Format: uri
- * @description URL for the pull request that the review comment belongs to.
- */
- readonly pull_request_url: string;
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /**
- * @description The side of the first line of the range for a multi-line comment.
- * @enum {string}
- */
- readonly side: "LEFT" | "RIGHT";
- /** @description The first line of the range for a multi-line comment. */
- readonly start_line: number | null;
- /**
- * @description The side of the first line of the range for a multi-line comment.
- * @default RIGHT
- * @enum {string|null}
- */
- readonly start_side: "LEFT" | "RIGHT" | null;
- /**
- * @description The level at which the comment is targeted, can be a diff line or a file.
- * @enum {string}
- */
- readonly subject_type?: "line" | "file";
- /** Format: date-time */
- readonly updated_at: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
/**
* Format: uri
- * @description URL for the pull request review comment
+ * @description URL for the team
*/
readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- }[];
- readonly node_id: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
+ /** @enum {string} */
+ readonly privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url?: string;
};
+ readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** pull_request_review_thread unresolved event */
- readonly "webhook-pull-request-review-thread-unresolved": {
+ /** pull_request_review submitted event */
+ readonly "webhook-pull-request-review-submitted": {
/** @enum {string} */
- readonly action: "unresolved";
+ readonly action: "submitted";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
@@ -77440,7 +70393,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
@@ -77476,7 +70429,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -77494,7 +70447,7 @@ export type components = {
/** @description Commit message for the merge commit. */
readonly commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string;
+ readonly commit_title: string | null;
/** User */
readonly enabled_by: {
/** Format: uri */
@@ -77684,6 +70637,23 @@ export type components = {
readonly url: string | null;
} | null;
readonly master_branch?: string;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
readonly merges_url: string;
/** Format: uri-template */
@@ -77752,6 +70722,23 @@ export type components = {
readonly releases_url: string;
readonly role_name?: string | null;
readonly size: number;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
readonly ssh_url: string;
readonly stargazers?: number;
readonly stargazers_count: number;
@@ -77776,6 +70763,11 @@ export type components = {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
/** @enum {string} */
readonly visibility: "public" | "private" | "internal";
readonly watchers: number;
@@ -77833,7 +70825,7 @@ export type components = {
readonly diff_url: string;
readonly draft: boolean;
readonly head: {
- readonly label: string;
+ readonly label: string | null;
readonly ref: string;
/**
* Repository
@@ -77978,6 +70970,23 @@ export type components = {
readonly url: string | null;
} | null;
readonly master_branch?: string;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
readonly merges_url: string;
/** Format: uri-template */
@@ -78046,6 +71055,23 @@ export type components = {
readonly releases_url: string;
readonly role_name?: string | null;
readonly size: number;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
readonly ssh_url: string;
readonly stargazers?: number;
readonly stargazers_count: number;
@@ -78070,13 +71096,18 @@ export type components = {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
/** @enum {string} */
readonly visibility: "public" | "private" | "internal";
readonly watchers: number;
readonly watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
readonly web_commit_signoff_required?: boolean;
- };
+ } | null;
readonly sha: string;
/** User */
readonly user: {
@@ -78182,7 +71213,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
@@ -78246,22 +71277,22 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null) | {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ readonly description: string | null;
/** Format: uri */
- readonly html_url?: string;
+ readonly html_url: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ readonly members_url: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id?: string;
+ readonly node_id: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -78288,17 +71319,17 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ readonly permission: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ readonly privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ readonly repositories_url: string;
+ readonly slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ readonly url: string;
})[];
readonly requested_teams: {
readonly deleted?: boolean;
@@ -78365,285 +71396,6 @@ export type components = {
readonly url: string;
/** User */
readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- readonly thread: {
- readonly comments: {
- readonly _links: {
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly pull_request: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly self: {
- /** Format: uri-template */
- readonly href: string;
- };
- };
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description The text of the comment. */
- readonly body: string;
- /** @description The SHA of the commit to which the comment applies. */
- readonly commit_id: string;
- /** Format: date-time */
- readonly created_at: string;
- /** @description The diff of the line that the comment refers to. */
- readonly diff_hunk: string;
- /**
- * Format: uri
- * @description HTML URL for the pull request review comment.
- */
- readonly html_url: string;
- /** @description The ID of the pull request review comment. */
- readonly id: number;
- /** @description The comment ID to reply to. */
- readonly in_reply_to_id?: number;
- /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly line: number | null;
- /** @description The node ID of the pull request review comment. */
- readonly node_id: string;
- /** @description The SHA of the original commit to which the comment applies. */
- readonly original_commit_id: string;
- /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly original_line: number;
- /** @description The index of the original line in the diff to which the comment applies. */
- readonly original_position: number;
- /** @description The first line of the range for a multi-line comment. */
- readonly original_start_line: number | null;
- /** @description The relative path of the file to which the comment applies. */
- readonly path: string;
- /** @description The line index in the diff to which the comment applies. */
- readonly position: number | null;
- /** @description The ID of the pull request review to which the comment belongs. */
- readonly pull_request_review_id: number | null;
- /**
- * Format: uri
- * @description URL for the pull request that the review comment belongs to.
- */
- readonly pull_request_url: string;
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /**
- * @description The side of the first line of the range for a multi-line comment.
- * @enum {string}
- */
- readonly side: "LEFT" | "RIGHT";
- /** @description The first line of the range for a multi-line comment. */
- readonly start_line: number | null;
- /**
- * @description The side of the first line of the range for a multi-line comment.
- * @default RIGHT
- * @enum {string|null}
- */
- readonly start_side: "LEFT" | "RIGHT" | null;
- /**
- * @description The level at which the comment is targeted, can be a diff line or a file.
- * @enum {string}
- */
- readonly subject_type?: "line" | "file";
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the pull request review comment
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- }[];
- readonly node_id: string;
- };
- };
- /** pull_request synchronize event */
- readonly "webhook-pull-request-synchronize": {
- /** @enum {string} */
- readonly action: "synchronize";
- readonly after: string;
- readonly before: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The pull request number. */
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Pull Request */
- readonly pull_request: {
- readonly _links: {
- /** Link */
- readonly comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly commits: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly issue: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comment: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly self: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly statuses: {
- /** Format: uri-template */
- readonly href: string;
- };
- };
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
- /** User */
- readonly assignee: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -78678,6 +71430,137 @@ export type components = {
readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
+ } | null;
+ };
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly review: components["schemas"]["webhooks_review"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request_review_thread resolved event */
+ readonly "webhook-pull-request-review-thread-resolved": {
+ /** @enum {string} */
+ readonly action: "resolved";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Simple Pull Request */
+ readonly pull_request: {
+ readonly _links: {
+ /** Link */
+ readonly comments: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly commits: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly html: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly issue: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comment: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comments: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly self: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly statuses: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ };
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ /** User */
+ readonly assignee: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
} | null)[];
/**
* AuthorAssociation
@@ -78883,23 +71766,6 @@ export type components = {
readonly url: string | null;
} | null;
readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
readonly merges_url: string;
/** Format: uri-template */
@@ -78968,23 +71834,6 @@ export type components = {
readonly releases_url: string;
readonly role_name?: string | null;
readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
readonly ssh_url: string;
readonly stargazers?: number;
readonly stargazers_count: number;
@@ -79009,11 +71858,6 @@ export type components = {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
/** @enum {string} */
readonly visibility: "public" | "private" | "internal";
readonly watchers: number;
@@ -79061,24 +71905,17 @@ export type components = {
} | null;
};
readonly body: string | null;
- readonly changed_files?: number;
- /** Format: date-time */
readonly closed_at: string | null;
- readonly comments?: number;
/** Format: uri */
readonly comments_url: string;
- readonly commits?: number;
/** Format: uri */
readonly commits_url: string;
- /** Format: date-time */
readonly created_at: string;
- readonly deletions?: number;
/** Format: uri */
readonly diff_url: string;
- /** @description Indicates whether or not the pull request is a draft. */
readonly draft: boolean;
readonly head: {
- readonly label: string;
+ readonly label: string | null;
readonly ref: string;
/**
* Repository
@@ -79223,16 +72060,6 @@ export type components = {
readonly url: string | null;
} | null;
readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit message title.
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
readonly merges_url: string;
/** Format: uri-template */
@@ -79301,23 +72128,6 @@ export type components = {
readonly releases_url: string;
readonly role_name?: string | null;
readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
readonly ssh_url: string;
readonly stargazers?: number;
readonly stargazers_count: number;
@@ -79342,18 +72152,13 @@ export type components = {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
/** @enum {string} */
readonly visibility: "public" | "private" | "internal";
readonly watchers: number;
readonly watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
readonly web_commit_signoff_required?: boolean;
- };
+ } | null;
readonly sha: string;
/** User */
readonly user: {
@@ -79414,51 +72219,8 @@ export type components = {
readonly url: string;
}[];
readonly locked: boolean;
- /** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
- /** Format: date-time */
readonly merged_at: string | null;
- /** User */
- readonly merged_by?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
@@ -79502,7 +72264,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -79531,11 +72293,9 @@ export type components = {
readonly url: string;
} | null;
readonly node_id: string;
- /** @description Number uniquely identifying the pull request within its repository. */
readonly number: number;
/** Format: uri */
readonly patch_url: string;
- readonly rebaseable?: boolean | null;
readonly requested_reviewers: (({
/** Format: uri */
readonly avatar_url?: string;
@@ -79675,19 +72435,13 @@ export type components = {
}[];
/** Format: uri-template */
readonly review_comment_url: string;
- readonly review_comments?: number;
/** Format: uri */
readonly review_comments_url: string;
- /**
- * @description State of this Pull Request. Either `open` or `closed`.
- * @enum {string}
- */
+ /** @enum {string} */
readonly state: "open" | "closed";
/** Format: uri */
readonly statuses_url: string;
- /** @description The title of the pull request. */
readonly title: string;
- /** Format: date-time */
readonly updated_at: string;
/** Format: uri */
readonly url: string;
@@ -79730,55 +72484,160 @@ export type components = {
} | null;
};
readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ readonly thread: {
+ readonly comments: {
+ readonly _links: {
+ /** Link */
+ readonly html: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly pull_request: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly self: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description The text of the comment. */
+ readonly body: string;
+ /** @description The SHA of the commit to which the comment applies. */
+ readonly commit_id: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** @description The diff of the line that the comment refers to. */
+ readonly diff_hunk: string;
+ /**
+ * Format: uri
+ * @description HTML URL for the pull request review comment.
+ */
+ readonly html_url: string;
+ /** @description The ID of the pull request review comment. */
+ readonly id: number;
+ /** @description The comment ID to reply to. */
+ readonly in_reply_to_id?: number;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ readonly line: number | null;
+ /** @description The node ID of the pull request review comment. */
+ readonly node_id: string;
+ /** @description The SHA of the original commit to which the comment applies. */
+ readonly original_commit_id: string;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ readonly original_line: number | null;
+ /** @description The index of the original line in the diff to which the comment applies. */
+ readonly original_position: number;
+ /** @description The first line of the range for a multi-line comment. */
+ readonly original_start_line: number | null;
+ /** @description The relative path of the file to which the comment applies. */
+ readonly path: string;
+ /** @description The line index in the diff to which the comment applies. */
+ readonly position: number | null;
+ /** @description The ID of the pull request review to which the comment belongs. */
+ readonly pull_request_review_id: number | null;
+ /**
+ * Format: uri
+ * @description URL for the pull request that the review comment belongs to.
+ */
+ readonly pull_request_url: string;
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @enum {string}
+ */
+ readonly side: "LEFT" | "RIGHT";
+ /** @description The first line of the range for a multi-line comment. */
+ readonly start_line: number | null;
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @default RIGHT
+ * @enum {string|null}
+ */
+ readonly start_side: "LEFT" | "RIGHT" | null;
+ /**
+ * @description The level at which the comment is targeted, can be a diff line or a file.
+ * @enum {string}
+ */
+ readonly subject_type?: "line" | "file";
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the pull request review comment
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ }[];
+ readonly node_id: string;
+ };
};
- /** pull_request unassigned event */
- readonly "webhook-pull-request-unassigned": {
+ /** pull_request_review_thread unresolved event */
+ readonly "webhook-pull-request-review-thread-unresolved": {
/** @enum {string} */
- readonly action: "unassigned";
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
+ readonly action: "unresolved";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** @description The pull request number. */
- readonly number: number;
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Pull Request */
+ /** Simple Pull Request */
readonly pull_request: {
readonly _links: {
/** Link */
@@ -79824,7 +72683,6 @@ export type components = {
};
/** @enum {string|null} */
readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
/** User */
readonly assignee: {
/** Format: uri */
@@ -79858,7 +72716,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -79894,7 +72752,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -79912,7 +72770,7 @@ export type components = {
/** @description Commit message for the merge commit. */
readonly commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ readonly commit_title: string;
/** User */
readonly enabled_by: {
/** Format: uri */
@@ -79957,7 +72815,7 @@ export type components = {
readonly merge_method: "merge" | "squash" | "rebase";
} | null;
readonly base: {
- readonly label: string | null;
+ readonly label: string;
readonly ref: string;
/**
* Repository
@@ -80102,23 +72960,6 @@ export type components = {
readonly url: string | null;
} | null;
readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
readonly merges_url: string;
/** Format: uri-template */
@@ -80187,23 +73028,6 @@ export type components = {
readonly releases_url: string;
readonly role_name?: string | null;
readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
readonly ssh_url: string;
readonly stargazers?: number;
readonly stargazers_count: number;
@@ -80228,11 +73052,6 @@ export type components = {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
/** @enum {string} */
readonly visibility: "public" | "private" | "internal";
readonly watchers: number;
@@ -80280,24 +73099,17 @@ export type components = {
} | null;
};
readonly body: string | null;
- readonly changed_files?: number;
- /** Format: date-time */
readonly closed_at: string | null;
- readonly comments?: number;
/** Format: uri */
readonly comments_url: string;
- readonly commits?: number;
/** Format: uri */
readonly commits_url: string;
- /** Format: date-time */
readonly created_at: string;
- readonly deletions?: number;
/** Format: uri */
readonly diff_url: string;
- /** @description Indicates whether or not the pull request is a draft. */
readonly draft: boolean;
readonly head: {
- readonly label: string | null;
+ readonly label: string;
readonly ref: string;
/**
* Repository
@@ -80442,23 +73254,6 @@ export type components = {
readonly url: string | null;
} | null;
readonly master_branch?: string;
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
readonly merges_url: string;
/** Format: uri-template */
@@ -80527,23 +73322,6 @@ export type components = {
readonly releases_url: string;
readonly role_name?: string | null;
readonly size: number;
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
readonly ssh_url: string;
readonly stargazers?: number;
readonly stargazers_count: number;
@@ -80568,18 +73346,13 @@ export type components = {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
/** @enum {string} */
readonly visibility: "public" | "private" | "internal";
readonly watchers: number;
readonly watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
readonly web_commit_signoff_required?: boolean;
- } | null;
+ };
readonly sha: string;
/** User */
readonly user: {
@@ -80640,51 +73413,8 @@ export type components = {
readonly url: string;
}[];
readonly locked: boolean;
- /** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
- /** Format: date-time */
readonly merged_at: string | null;
- /** User */
- readonly merged_by?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
@@ -80728,7 +73458,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
@@ -80757,11 +73487,9 @@ export type components = {
readonly url: string;
} | null;
readonly node_id: string;
- /** @description Number uniquely identifying the pull request within its repository. */
readonly number: number;
/** Format: uri */
readonly patch_url: string;
- readonly rebaseable?: boolean | null;
readonly requested_reviewers: (({
/** Format: uri */
readonly avatar_url?: string;
@@ -80794,22 +73522,22 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null) | {
readonly deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ readonly description?: string | null;
/** Format: uri */
- readonly html_url: string;
+ readonly html_url?: string;
/** @description Unique identifier of the team */
readonly id: number;
/** Format: uri-template */
- readonly members_url: string;
+ readonly members_url?: string;
/** @description Name of the team */
readonly name: string;
- readonly node_id: string;
+ readonly node_id?: string;
readonly parent?: {
/** @description Description of the team */
readonly description: string | null;
@@ -80836,17 +73564,17 @@ export type components = {
readonly url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ readonly permission?: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ readonly privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ readonly repositories_url?: string;
+ readonly slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ readonly url?: string;
})[];
readonly requested_teams: {
readonly deleted?: boolean;
@@ -80901,19 +73629,13 @@ export type components = {
}[];
/** Format: uri-template */
readonly review_comment_url: string;
- readonly review_comments?: number;
/** Format: uri */
readonly review_comments_url: string;
- /**
- * @description State of this Pull Request. Either `open` or `closed`.
- * @enum {string}
- */
+ /** @enum {string} */
readonly state: "open" | "closed";
/** Format: uri */
readonly statuses_url: string;
- /** @description The title of the pull request. */
readonly title: string;
- /** Format: date-time */
readonly updated_at: string;
/** Format: uri */
readonly url: string;
@@ -80950,38 +73672,167 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
};
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender?: components["schemas"]["simple-user-webhooks"];
+ readonly thread: {
+ readonly comments: {
+ readonly _links: {
+ /** Link */
+ readonly html: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly pull_request: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly self: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description The text of the comment. */
+ readonly body: string;
+ /** @description The SHA of the commit to which the comment applies. */
+ readonly commit_id: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** @description The diff of the line that the comment refers to. */
+ readonly diff_hunk: string;
+ /**
+ * Format: uri
+ * @description HTML URL for the pull request review comment.
+ */
+ readonly html_url: string;
+ /** @description The ID of the pull request review comment. */
+ readonly id: number;
+ /** @description The comment ID to reply to. */
+ readonly in_reply_to_id?: number;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ readonly line: number | null;
+ /** @description The node ID of the pull request review comment. */
+ readonly node_id: string;
+ /** @description The SHA of the original commit to which the comment applies. */
+ readonly original_commit_id: string;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ readonly original_line: number;
+ /** @description The index of the original line in the diff to which the comment applies. */
+ readonly original_position: number;
+ /** @description The first line of the range for a multi-line comment. */
+ readonly original_start_line: number | null;
+ /** @description The relative path of the file to which the comment applies. */
+ readonly path: string;
+ /** @description The line index in the diff to which the comment applies. */
+ readonly position: number | null;
+ /** @description The ID of the pull request review to which the comment belongs. */
+ readonly pull_request_review_id: number | null;
+ /**
+ * Format: uri
+ * @description URL for the pull request that the review comment belongs to.
+ */
+ readonly pull_request_url: string;
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @enum {string}
+ */
+ readonly side: "LEFT" | "RIGHT";
+ /** @description The first line of the range for a multi-line comment. */
+ readonly start_line: number | null;
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @default RIGHT
+ * @enum {string|null}
+ */
+ readonly start_side: "LEFT" | "RIGHT" | null;
+ /**
+ * @description The level at which the comment is targeted, can be a diff line or a file.
+ * @enum {string}
+ */
+ readonly subject_type?: "line" | "file";
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the pull request review comment
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ }[];
+ readonly node_id: string;
+ };
};
- /** pull_request unlabeled event */
- readonly "webhook-pull-request-unlabeled": {
+ /** pull_request synchronize event */
+ readonly "webhook-pull-request-synchronize": {
/** @enum {string} */
- readonly action: "unlabeled";
+ readonly action: "synchronize";
+ readonly after: string;
+ readonly before: string;
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** Label */
- readonly label?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
- /** @description The pull request number. */
- readonly number: number;
+ readonly number: components["schemas"]["webhooks_number"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
readonly pull_request: {
@@ -81502,7 +74353,7 @@ export type components = {
/** @description Indicates whether or not the pull request is a draft. */
readonly draft: boolean;
readonly head: {
- readonly label: string | null;
+ readonly label: string;
readonly ref: string;
/**
* Repository
@@ -81777,7 +74628,7 @@ export type components = {
readonly watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
readonly web_commit_signoff_required?: boolean;
- } | null;
+ };
readonly sha: string;
/** User */
readonly user: {
@@ -82152,103 +75003,103 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** pull_request unlocked event */
- readonly "webhook-pull-request-unlocked": {
- /** @enum {string} */
- readonly action: "unlocked";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The pull request number. */
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Pull Request */
- readonly pull_request: {
- readonly _links: {
- /** Link */
- readonly comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly commits: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly html: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly issue: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comment: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly review_comments: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly self: {
- /** Format: uri-template */
- readonly href: string;
- };
- /** Link */
- readonly statuses: {
- /** Format: uri-template */
- readonly href: string;
- };
- };
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
- /** User */
- readonly assignee: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
+ };
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request unassigned event */
+ readonly "webhook-pull-request-unassigned": {
+ /** @enum {string} */
+ readonly action: "unassigned";
+ readonly assignee?: components["schemas"]["webhooks_user_mannequin"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly number: components["schemas"]["webhooks_number"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ readonly pull_request: {
+ readonly _links: {
+ /** Link */
+ readonly comments: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly commits: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly html: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly issue: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comment: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comments: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly self: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly statuses: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ };
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly additions?: number;
+ /** User */
+ readonly assignee: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
readonly assignees: ({
/** Format: uri */
readonly avatar_url?: string;
@@ -82281,7 +75132,7 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null)[];
@@ -82299,7 +75150,7 @@ export type components = {
/** @description Commit message for the merge commit. */
readonly commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string;
+ readonly commit_title: string | null;
/** User */
readonly enabled_by: {
/** Format: uri */
@@ -82344,7 +75195,7 @@ export type components = {
readonly merge_method: "merge" | "squash" | "rebase";
} | null;
readonly base: {
- readonly label: string;
+ readonly label: string | null;
readonly ref: string;
/**
* Repository
@@ -82684,7 +75535,7 @@ export type components = {
/** @description Indicates whether or not the pull request is a draft. */
readonly draft: boolean;
readonly head: {
- readonly label: string;
+ readonly label: string | null;
readonly ref: string;
/**
* Repository
@@ -82935,714 +75786,108 @@ export type components = {
readonly stargazers?: number;
readonly stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
- /** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
- /** Format: uri */
- readonly subscription_url: string;
- /** Format: uri */
- readonly svn_url: string;
- /** Format: uri */
- readonly tags_url: string;
- /** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
- /** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /**
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
- } | null;
- readonly sha: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly issue_url: string;
- readonly labels: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- readonly locked: boolean;
- /** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
- /** Format: date-time */
- readonly merged_at: string | null;
- /** User */
- readonly merged_by?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
+ readonly stargazers_url: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
+ readonly statuses_url: string;
/** Format: uri */
- readonly received_events_url?: string;
+ readonly subscribers_url: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
+ readonly subscription_url: string;
/** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly svn_url: string;
/** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- /** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
- /** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: (({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null) | {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
+ readonly tags_url: string;
/** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
+ readonly teams_url: string;
+ readonly topics: string[];
/** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ readonly trees_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- })[];
- readonly requested_teams: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
/**
- * Format: uri
- * @description URL for the team
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
*/
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- }[];
- /** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
- /** Format: uri */
- readonly review_comments_url: string;
- /**
- * @description State of this Pull Request. Either `open` or `closed`.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** Format: uri */
- readonly statuses_url: string;
- /** @description The title of the pull request. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** push event */
- readonly "webhook-push": {
- /** @description The SHA of the most recent commit on `ref` after the push. */
- readonly after: string;
- readonly base_ref: string | null;
- /** @description The SHA of the most recent commit on `ref` before the push. */
- readonly 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/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */
- readonly commits: {
- /** @description An array of files added in the commit. */
- readonly added?: string[];
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly author: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly committer: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- /** @description Whether this commit is distinct from any that have been pushed before. */
- readonly distinct: boolean;
- readonly id: string;
- /** @description The commit message. */
- readonly message: string;
- /** @description An array of files modified by the commit. */
- readonly modified?: string[];
- /** @description An array of files removed in the commit. */
- readonly removed?: string[];
- /**
- * Format: date-time
- * @description The ISO 8601 timestamp of the commit.
- */
- readonly timestamp: string;
- readonly tree_id: string;
- /**
- * Format: uri
- * @description URL that points to the commit API resource.
- */
- readonly url: string;
- }[];
- /** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */
- readonly compare: string;
- /** @description Whether this push created the `ref`. */
- readonly created: boolean;
- /** @description Whether this push deleted the `ref`. */
- readonly deleted: boolean;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- /** @description Whether this push was a force push of the `ref`. */
- readonly forced: boolean;
- /** Commit */
- readonly head_commit: {
- /** @description An array of files added in the commit. */
- readonly added?: string[];
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly author: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly committer: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- /** @description Whether this commit is distinct from any that have been pushed before. */
- readonly distinct: boolean;
- readonly id: string;
- /** @description The commit message. */
- readonly message: string;
- /** @description An array of files modified by the commit. */
- readonly modified?: string[];
- /** @description An array of files removed in the commit. */
- readonly removed?: string[];
- /**
- * Format: date-time
- * @description The ISO 8601 timestamp of the commit.
- */
- readonly timestamp: string;
- readonly tree_id: string;
- /**
- * Format: uri
- * @description URL that points to the commit API resource.
- */
- readonly url: string;
- } | null;
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly pusher: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email?: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- /** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */
- readonly ref: string;
- /**
- * Repository
- * @description A git repository
- */
- readonly repository: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
- /** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
- /** Format: uri-template */
- readonly assignees_url: string;
- /** Format: uri-template */
- readonly blobs_url: string;
- /** Format: uri-template */
- readonly branches_url: string;
- /** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
- /** Format: uri-template */
- readonly commits_url: string;
- /** Format: uri-template */
- readonly compare_url: string;
- /** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
- };
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
- /** Format: uri */
- readonly downloads_url: string;
- /** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
- /** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
- /** Format: uri-template */
- readonly git_tags_url: string;
- /** Format: uri */
- readonly git_url: string;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- */
- readonly has_discussions: boolean;
- readonly homepage: string | null;
- /** Format: uri */
- readonly hooks_url: string;
+ readonly use_squash_pr_title_as_default: boolean;
+ /** @enum {string} */
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
+ } | null;
+ readonly sha: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
/** Format: uri */
readonly html_url: string;
- /** @description Unique identifier of the repository */
readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
- /** Format: uri-template */
- readonly issues_url: string;
- /** Format: uri-template */
- readonly keys_url: string;
- /** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
/** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
+ readonly issue_url: string;
+ readonly labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
readonly name: string;
readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
- /** Format: uri */
- readonly merges_url: string;
- /** Format: uri-template */
- readonly milestones_url: string;
- /** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ readonly locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ readonly maintainer_can_modify?: boolean;
+ readonly merge_commit_sha: string | null;
+ readonly mergeable?: boolean | null;
+ readonly mergeable_state?: string;
+ readonly merged?: boolean | null;
+ /** Format: date-time */
+ readonly merged_at: string | null;
/** User */
- readonly owner: {
+ readonly merged_by?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -83674,423 +75919,757 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- };
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
- /** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
- /** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
- /** Format: uri */
- readonly subscription_url: string;
- /** Format: uri */
- readonly svn_url: string;
- /** Format: uri */
- readonly tags_url: string;
- /** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
- /** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
- };
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- readonly "webhook-registry-package-published": {
- /** @enum {string} */
- readonly action: "published";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly registry_package: {
- readonly created_at: string | null;
- readonly description: string | null;
- readonly ecosystem: string;
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly namespace: string;
- readonly owner: {
- readonly avatar_url: string;
- readonly events_url: string;
- readonly followers_url: string;
- readonly following_url: string;
- readonly gists_url: string;
- readonly gravatar_id: string;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
readonly html_url: string;
readonly id: number;
- readonly login: string;
+ /** Format: uri */
+ readonly labels_url: string;
readonly node_id: string;
- readonly organizations_url: string;
- readonly received_events_url: string;
- readonly repos_url: string;
- readonly site_admin: boolean;
- readonly starred_url: string;
- readonly subscriptions_url: string;
- readonly type: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
readonly url: string;
- };
- readonly package_type: string;
- readonly package_version: {
- readonly author?: {
- readonly avatar_url: string;
- readonly events_url: string;
- readonly followers_url: string;
- readonly following_url: string;
- readonly gists_url: string;
- readonly gravatar_id: string;
+ } | null;
+ readonly node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ readonly number: number;
+ /** Format: uri */
+ readonly patch_url: string;
+ readonly rebaseable?: boolean | null;
+ readonly requested_reviewers: (({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null) | {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
readonly html_url: string;
+ /** @description Unique identifier of the team */
readonly id: number;
- readonly login: string;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
readonly node_id: string;
- readonly organizations_url: string;
- readonly received_events_url: string;
- readonly repos_url: string;
- readonly site_admin: boolean;
- readonly starred_url: string;
- readonly subscriptions_url: string;
- readonly type: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
readonly url: string;
- };
- readonly body?: string | Record;
- readonly body_html?: string;
- readonly container_metadata?: {
- readonly labels?: Record;
- readonly manifest?: Record;
- readonly tag?: {
- readonly digest?: string;
- readonly name?: string;
- };
- };
- readonly created_at?: string;
- readonly description: string;
- readonly docker_metadata?: {
- readonly tags?: string[];
- }[];
- readonly draft?: boolean;
- readonly html_url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
+ })[];
+ readonly requested_teams: {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
readonly id: number;
- readonly installation_command: string;
- readonly manifest?: string;
- readonly metadata: {
- readonly [key: string]: unknown;
- }[];
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
readonly name: string;
- readonly npm_metadata?: {
- readonly name?: string;
- readonly version?: string;
- readonly npm_user?: string;
- readonly author?: (string | Record) | null;
- readonly bugs?: (string | Record) | null;
- readonly dependencies?: Record;
- readonly dev_dependencies?: Record;
- readonly peer_dependencies?: Record;
- readonly optional_dependencies?: Record;
- readonly description?: string;
- readonly dist?: (string | Record) | null;
- readonly git_head?: string;
- readonly homepage?: string;
- readonly license?: string;
- readonly main?: string;
- readonly repository?: (string | Record) | null;
- readonly scripts?: Record;
- readonly id?: string;
- readonly node_version?: string;
- readonly npm_version?: string;
- readonly has_shrinkwrap?: boolean;
- readonly maintainers?: string[];
- readonly contributors?: string[];
- readonly engines?: Record;
- readonly keywords?: string[];
- readonly files?: string[];
- readonly bin?: Record;
- readonly man?: Record;
- readonly directories?: (string | Record) | null;
- readonly os?: string[];
- readonly cpu?: string[];
- readonly readme?: string;
- readonly installation_command?: string;
- readonly release_id?: number;
- readonly commit_oid?: string;
- readonly published_via_actions?: boolean;
- readonly deleted_by_id?: number;
- } | null;
- readonly nuget_metadata?: {
- readonly id?: (string | Record | number) | null;
- readonly name?: string;
- readonly value?: boolean | string | number | {
- readonly url?: string;
- readonly branch?: string;
- readonly commit?: string;
- readonly type?: string;
- };
- }[] | null;
- readonly package_files: {
- readonly content_type: string;
- readonly created_at: string;
- readonly download_url: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
readonly id: number;
- readonly md5: string | null;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
readonly name: string;
- readonly sha1: string | null;
- readonly sha256: string | null;
- readonly size: number;
- readonly state: string | null;
- readonly updated_at: string;
- }[];
- readonly package_url: string;
- readonly prerelease?: boolean;
- readonly release?: {
- readonly author?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly created_at?: string;
- readonly draft?: boolean;
- readonly html_url?: string;
- readonly id?: number;
- readonly name?: string | null;
- readonly prerelease?: boolean;
- readonly published_at?: string;
- readonly tag_name?: string;
- readonly target_commitish?: string;
- readonly url?: string;
- };
- readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
- readonly summary: string;
- readonly tag_name?: string;
- readonly target_commitish?: string;
- readonly target_oid?: string;
- readonly updated_at?: string;
- readonly version: string;
- } | null;
- readonly registry: {
- readonly about_url?: string;
+ readonly node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
+ /** @enum {string} */
+ readonly privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url?: string;
+ }[];
+ /** Format: uri-template */
+ readonly review_comment_url: string;
+ readonly review_comments?: number;
+ /** Format: uri */
+ readonly review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** Format: uri */
+ readonly statuses_url: string;
+ /** @description The title of the pull request. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
readonly name?: string;
- readonly type?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
readonly url?: string;
- readonly vendor?: string;
} | null;
- readonly updated_at: string | null;
};
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
};
- readonly "webhook-registry-package-updated": {
+ /** pull_request unlabeled event */
+ readonly "webhook-pull-request-unlabeled": {
/** @enum {string} */
- readonly action: "updated";
+ readonly action: "unlabeled";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
+ readonly label?: components["schemas"]["webhooks_label"];
+ readonly number: components["schemas"]["webhooks_number"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly registry_package: {
- readonly created_at: string;
- readonly description: unknown;
- readonly ecosystem: string;
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly namespace: string;
- readonly owner: {
- readonly avatar_url: string;
- readonly events_url: string;
- readonly followers_url: string;
- readonly following_url: string;
- readonly gists_url: string;
- readonly gravatar_id: string;
- readonly html_url: string;
+ /** Pull Request */
+ readonly pull_request: {
+ readonly _links: {
+ /** Link */
+ readonly comments: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly commits: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly html: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly issue: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comment: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comments: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly self: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly statuses: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ };
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly additions?: number;
+ /** User */
+ readonly assignee: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
readonly login: string;
- readonly node_id: string;
- readonly organizations_url: string;
- readonly received_events_url: string;
- readonly repos_url: string;
- readonly site_admin: boolean;
- readonly starred_url: string;
- readonly subscriptions_url: string;
- readonly type: string;
- readonly url: string;
- };
- readonly package_type: string;
- readonly package_version: {
- readonly author: {
- readonly avatar_url: string;
- readonly events_url: string;
- readonly followers_url: string;
- readonly following_url: string;
- readonly gists_url: string;
- readonly gravatar_id: string;
- readonly html_url: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ readonly auto_merge: {
+ /** @description Commit message for the merge commit. */
+ readonly commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ readonly commit_title: string | null;
+ /** User */
+ readonly enabled_by: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
readonly login: string;
- readonly node_id: string;
- readonly organizations_url: string;
- readonly received_events_url: string;
- readonly repos_url: string;
- readonly site_admin: boolean;
- readonly starred_url: string;
- readonly subscriptions_url: string;
- readonly type: string;
- readonly url: string;
- };
- readonly body: string;
- readonly body_html: string;
- readonly created_at: string;
- readonly description: string;
- readonly docker_metadata?: ({
- readonly tags?: string[];
- } | null)[];
- readonly draft?: boolean;
- readonly html_url: string;
- readonly id: number;
- readonly installation_command: string;
- readonly manifest?: string;
- readonly metadata: {
- readonly [key: string]: unknown;
- }[];
- readonly name: string;
- readonly package_files: {
- readonly content_type?: string;
- readonly created_at?: string;
- readonly download_url?: string;
- readonly id?: number;
- readonly md5?: string | null;
readonly name?: string;
- readonly sha1?: string | null;
- readonly sha256?: string;
- readonly size?: number;
- readonly state?: string;
- readonly updated_at?: string;
- }[];
- readonly package_url: string;
- readonly prerelease?: boolean;
- readonly release?: {
- readonly author: {
- readonly avatar_url: string;
- readonly events_url: string;
- readonly followers_url: string;
- readonly following_url: string;
- readonly gists_url: string;
- readonly gravatar_id: string;
- readonly html_url: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ readonly merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ readonly base: {
+ readonly label: string;
+ readonly ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ readonly repo: {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow private forks */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ readonly allow_rebase_merge: boolean;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ readonly allow_squash_merge: boolean;
+ readonly allow_update_branch?: boolean;
+ /** Format: uri-template */
+ readonly archive_url: string;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
+ /** Format: uri-template */
+ readonly assignees_url: string;
+ /** Format: uri-template */
+ readonly blobs_url: string;
+ /** Format: uri-template */
+ readonly branches_url: string;
+ /** Format: uri */
+ readonly clone_url: string;
+ /** Format: uri-template */
+ readonly collaborators_url: string;
+ /** Format: uri-template */
+ readonly comments_url: string;
+ /** Format: uri-template */
+ readonly commits_url: string;
+ /** Format: uri-template */
+ readonly compare_url: string;
+ /** Format: uri-template */
+ readonly contents_url: string;
+ /** Format: uri */
+ readonly contributors_url: string;
+ readonly created_at: number | string;
+ /** @description The default branch of the repository. */
+ readonly default_branch: string;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /** Format: uri */
+ readonly deployments_url: string;
+ readonly description: string | null;
+ /** @description Returns whether or not this repository is disabled. */
+ readonly disabled?: boolean;
+ /** Format: uri */
+ readonly downloads_url: string;
+ /** Format: uri */
+ readonly events_url: string;
+ readonly fork: boolean;
+ readonly forks: number;
+ readonly forks_count: number;
+ /** Format: uri */
+ readonly forks_url: string;
+ readonly full_name: string;
+ /** Format: uri-template */
+ readonly git_commits_url: string;
+ /** Format: uri-template */
+ readonly git_refs_url: string;
+ /** Format: uri-template */
+ readonly git_tags_url: string;
+ /** Format: uri */
+ readonly git_url: string;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ readonly has_issues: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ readonly has_wiki: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ readonly has_discussions: boolean;
+ readonly homepage: string | null;
+ /** Format: uri */
+ readonly hooks_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ readonly is_template?: boolean;
+ /** Format: uri-template */
+ readonly issue_comment_url: string;
+ /** Format: uri-template */
+ readonly issue_events_url: string;
+ /** Format: uri-template */
+ readonly issues_url: string;
+ /** Format: uri-template */
+ readonly keys_url: string;
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly language: string | null;
+ /** Format: uri */
+ readonly languages_url: string;
+ /** License */
+ readonly license: {
+ readonly key: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly spdx_id: string;
+ /** Format: uri */
+ readonly url: string | null;
+ } | null;
+ readonly master_branch?: string;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** Format: uri */
+ readonly merges_url: string;
+ /** Format: uri-template */
+ readonly milestones_url: string;
+ /** Format: uri */
+ readonly mirror_url: string | null;
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** Format: uri-template */
+ readonly notifications_url: string;
+ readonly open_issues: number;
+ readonly open_issues_count: number;
+ readonly organization?: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
readonly login: string;
- readonly node_id: string;
- readonly organizations_url: string;
- readonly received_events_url: string;
- readonly repos_url: string;
- readonly site_admin: boolean;
- readonly starred_url: string;
- readonly subscriptions_url: string;
- readonly type: string;
- readonly url: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly pull: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
};
- readonly created_at: string;
- readonly draft: boolean;
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly prerelease: boolean;
- readonly published_at: string;
- readonly tag_name: string;
- readonly target_commitish: string;
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ readonly public?: boolean;
+ /** Format: uri-template */
+ readonly pulls_url: string;
+ readonly pushed_at: (number | string) | null;
+ /** Format: uri-template */
+ readonly releases_url: string;
+ readonly role_name?: string | null;
+ readonly size: number;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly ssh_url: string;
+ readonly stargazers?: number;
+ readonly stargazers_count: number;
+ /** Format: uri */
+ readonly stargazers_url: string;
+ /** Format: uri-template */
+ readonly statuses_url: string;
+ /** Format: uri */
+ readonly subscribers_url: string;
+ /** Format: uri */
+ readonly subscription_url: string;
+ /** Format: uri */
+ readonly svn_url: string;
+ /** Format: uri */
+ readonly tags_url: string;
+ /** Format: uri */
+ readonly teams_url: string;
+ readonly topics: string[];
+ /** Format: uri-template */
+ readonly trees_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
+ /** @enum {string} */
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
};
- readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
- readonly summary: string;
- readonly tag_name?: string;
- readonly target_commitish: string;
- readonly target_oid: string;
- readonly updated_at: string;
- readonly version: string;
- };
- readonly registry: Record;
- readonly updated_at: string;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** release created event */
- readonly "webhook-release-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /**
- * Release
- * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
- */
- readonly release: {
- readonly assets: {
- /** Format: uri */
- readonly browser_download_url: string;
- readonly content_type: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly download_count: number;
- readonly id: number;
- readonly label: string | null;
- /** @description The file name of the asset. */
- readonly name: string;
- readonly node_id: string;
- readonly size: number;
- /**
- * @description State of the release asset.
- * @enum {string}
- */
- readonly state: "uploaded";
- /** Format: date-time */
- readonly updated_at: string;
+ readonly sha: string;
/** User */
- readonly uploader?: {
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -84126,128 +76705,304 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- /** Format: uri */
- readonly url: string;
- }[];
- /** Format: uri */
- readonly assets_url: string;
- /** User */
- readonly author: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
+ };
readonly body: string | null;
+ readonly changed_files?: number;
/** Format: date-time */
- readonly created_at: string | null;
+ readonly closed_at: string | null;
+ readonly comments?: number;
/** Format: uri */
- readonly discussion_url?: string;
- /** @description Whether the release is a draft or published */
- readonly draft: boolean;
+ readonly comments_url: string;
+ readonly commits?: number;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly node_id: string;
- /** @description Whether the release is identified as a prerelease or a full release. */
- readonly prerelease: boolean;
+ readonly commits_url: string;
/** Format: date-time */
- readonly published_at: string | null;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** @description The name of the tag. */
- readonly tag_name: string;
- /** Format: uri */
- readonly tarball_url: string | null;
- /** @description Specifies the commitish value that determines where the Git tag is created from. */
- readonly target_commitish: string;
- /** Format: uri-template */
- readonly upload_url: string;
- /** Format: uri */
- readonly url: string;
+ readonly created_at: string;
+ readonly deletions?: number;
/** Format: uri */
- readonly zipball_url: string | null;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** release deleted event */
- readonly "webhook-release-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /**
- * Release
- * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
- */
- readonly release: {
- readonly assets: {
- /** Format: uri */
- readonly browser_download_url: string;
- readonly content_type: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly download_count: number;
- readonly id: number;
+ readonly diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ readonly draft: boolean;
+ readonly head: {
readonly label: string | null;
- /** @description The file name of the asset. */
- readonly name: string;
- readonly node_id: string;
- readonly size: number;
+ readonly ref: string;
/**
- * @description State of the release asset.
- * @enum {string}
+ * Repository
+ * @description A git repository
*/
- readonly state: "uploaded";
- /** Format: date-time */
- readonly updated_at: string;
+ readonly repo: {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow private forks */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ readonly allow_rebase_merge: boolean;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ readonly allow_squash_merge: boolean;
+ readonly allow_update_branch?: boolean;
+ /** Format: uri-template */
+ readonly archive_url: string;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
+ /** Format: uri-template */
+ readonly assignees_url: string;
+ /** Format: uri-template */
+ readonly blobs_url: string;
+ /** Format: uri-template */
+ readonly branches_url: string;
+ /** Format: uri */
+ readonly clone_url: string;
+ /** Format: uri-template */
+ readonly collaborators_url: string;
+ /** Format: uri-template */
+ readonly comments_url: string;
+ /** Format: uri-template */
+ readonly commits_url: string;
+ /** Format: uri-template */
+ readonly compare_url: string;
+ /** Format: uri-template */
+ readonly contents_url: string;
+ /** Format: uri */
+ readonly contributors_url: string;
+ readonly created_at: number | string;
+ /** @description The default branch of the repository. */
+ readonly default_branch: string;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /** Format: uri */
+ readonly deployments_url: string;
+ readonly description: string | null;
+ /** @description Returns whether or not this repository is disabled. */
+ readonly disabled?: boolean;
+ /** Format: uri */
+ readonly downloads_url: string;
+ /** Format: uri */
+ readonly events_url: string;
+ readonly fork: boolean;
+ readonly forks: number;
+ readonly forks_count: number;
+ /** Format: uri */
+ readonly forks_url: string;
+ readonly full_name: string;
+ /** Format: uri-template */
+ readonly git_commits_url: string;
+ /** Format: uri-template */
+ readonly git_refs_url: string;
+ /** Format: uri-template */
+ readonly git_tags_url: string;
+ /** Format: uri */
+ readonly git_url: string;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ readonly has_issues: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ readonly has_wiki: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ readonly has_discussions: boolean;
+ readonly homepage: string | null;
+ /** Format: uri */
+ readonly hooks_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ readonly is_template?: boolean;
+ /** Format: uri-template */
+ readonly issue_comment_url: string;
+ /** Format: uri-template */
+ readonly issue_events_url: string;
+ /** Format: uri-template */
+ readonly issues_url: string;
+ /** Format: uri-template */
+ readonly keys_url: string;
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly language: string | null;
+ /** Format: uri */
+ readonly languages_url: string;
+ /** License */
+ readonly license: {
+ readonly key: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly spdx_id: string;
+ /** Format: uri */
+ readonly url: string | null;
+ } | null;
+ readonly master_branch?: string;
+ /**
+ * @description The default value for a merge commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit message title.
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** Format: uri */
+ readonly merges_url: string;
+ /** Format: uri-template */
+ readonly milestones_url: string;
+ /** Format: uri */
+ readonly mirror_url: string | null;
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** Format: uri-template */
+ readonly notifications_url: string;
+ readonly open_issues: number;
+ readonly open_issues_count: number;
+ readonly organization?: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly pull: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
+ };
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ readonly public?: boolean;
+ /** Format: uri-template */
+ readonly pulls_url: string;
+ readonly pushed_at: (number | string) | null;
+ /** Format: uri-template */
+ readonly releases_url: string;
+ readonly role_name?: string | null;
+ readonly size: number;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly ssh_url: string;
+ readonly stargazers?: number;
+ readonly stargazers_count: number;
+ /** Format: uri */
+ readonly stargazers_url: string;
+ /** Format: uri-template */
+ readonly statuses_url: string;
+ /** Format: uri */
+ readonly subscribers_url: string;
+ /** Format: uri */
+ readonly subscription_url: string;
+ /** Format: uri */
+ readonly svn_url: string;
+ /** Format: uri */
+ readonly tags_url: string;
+ /** Format: uri */
+ readonly teams_url: string;
+ readonly topics: string[];
+ /** Format: uri-template */
+ readonly trees_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
+ /** @enum {string} */
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
+ } | null;
+ readonly sha: string;
/** User */
- readonly uploader?: {
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -84283,13 +77038,38 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- /** Format: uri */
+ };
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly issue_url: string;
+ readonly labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
readonly url: string;
}[];
- /** Format: uri */
- readonly assets_url: string;
+ readonly locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ readonly maintainer_can_modify?: boolean;
+ readonly merge_commit_sha: string | null;
+ readonly mergeable?: boolean | null;
+ readonly mergeable_state?: string;
+ readonly merged?: boolean | null;
+ /** Format: date-time */
+ readonly merged_at: string | null;
/** User */
- readonly author: {
+ readonly merged_by?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -84325,100 +77105,18 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- readonly body: string | null;
- /** Format: date-time */
- readonly created_at: string | null;
- /** Format: uri */
- readonly discussion_url?: string;
- /** @description Whether the release is a draft or published */
- readonly draft: boolean;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly node_id: string;
- /** @description Whether the release is identified as a prerelease or a full release. */
- readonly prerelease: boolean;
- /** Format: date-time */
- readonly published_at: string | null;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** @description The name of the tag. */
- readonly tag_name: string;
- /** Format: uri */
- readonly tarball_url: string | null;
- /** @description Specifies the commitish value that determines where the Git tag is created from. */
- readonly target_commitish: string;
- /** Format: uri-template */
- readonly upload_url: string;
- /** Format: uri */
- readonly url: string;
- /** Format: uri */
- readonly zipball_url: string | null;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** release edited event */
- readonly "webhook-release-edited": {
- /** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly body?: {
- /** @description The previous version of the body if the action was `edited`. */
- readonly from: string;
- };
- readonly name?: {
- /** @description The previous version of the name if the action was `edited`. */
- readonly from: string;
- };
- readonly make_latest?: {
- /** @description Whether this release was explicitly `edited` to be the latest. */
- readonly to: boolean;
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /**
- * Release
- * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
- */
- readonly release: {
- readonly assets: {
- /** Format: uri */
- readonly browser_download_url: string;
- readonly content_type: string;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
/** Format: date-time */
- readonly created_at: string;
- readonly download_count: number;
- readonly id: number;
- readonly label: string | null;
- /** @description The file name of the asset. */
- readonly name: string;
- readonly node_id: string;
- readonly size: number;
- /**
- * @description State of the release asset.
- * @enum {string}
- */
- readonly state: "uploaded";
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
/** Format: date-time */
- readonly updated_at: string;
+ readonly created_at: string;
/** User */
- readonly uploader?: {
+ readonly creator: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -84450,17 +77148,41 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
/** Format: uri */
readonly url: string;
- }[];
+ } | null;
+ readonly node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ readonly number: number;
/** Format: uri */
- readonly assets_url: string;
- /** User */
- readonly author: {
+ readonly patch_url: string;
+ readonly rebaseable?: boolean | null;
+ readonly requested_reviewers: (({
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -84492,128 +77214,131 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
- } | null;
- readonly body: string | null;
- /** Format: date-time */
- readonly created_at: string | null;
- /** Format: uri */
- readonly discussion_url?: string;
- /** @description Whether the release is a draft or published */
- readonly draft: boolean;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly node_id: string;
- /** @description Whether the release is identified as a prerelease or a full release. */
- readonly prerelease: boolean;
- /** Format: date-time */
- readonly published_at: string | null;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** @description The name of the tag. */
- readonly tag_name: string;
- /** Format: uri */
- readonly tarball_url: string | null;
- /** @description Specifies the commitish value that determines where the Git tag is created from. */
- readonly target_commitish: string;
- /** Format: uri-template */
- readonly upload_url: string;
- /** Format: uri */
- readonly url: string;
- /** Format: uri */
- readonly zipball_url: string | null;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** release prereleased event */
- readonly "webhook-release-prereleased": {
- /** @enum {string} */
- readonly action: "prereleased";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly release: {
- readonly assets: {
+ } | null) | {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description: string | null;
/** Format: uri */
- readonly browser_download_url: string;
- readonly content_type: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly download_count: number;
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
readonly id: number;
- readonly label: string | null;
- /** @description The file name of the asset. */
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
readonly name: string;
readonly node_id: string;
- readonly size: number;
- /**
- * @description State of the release asset.
- * @enum {string}
- */
- readonly state: "uploaded";
- /** Format: date-time */
- readonly updated_at: string;
- /** User */
- readonly uploader?: {
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
/** Format: uri-template */
- readonly events_url?: string;
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
+ })[];
+ readonly requested_teams: {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
/** Format: uri */
- readonly html_url?: string;
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly url?: string;
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
} | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
+ /** @enum {string} */
+ readonly privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly url: string;
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url?: string;
}[];
+ /** Format: uri-template */
+ readonly review_comment_url: string;
+ readonly review_comments?: number;
/** Format: uri */
- readonly assets_url: string;
+ readonly review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** Format: uri */
+ readonly statuses_url: string;
+ /** @description The title of the pull request. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
/** User */
- readonly author: {
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -84645,170 +77370,71 @@ export type components = {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- readonly body: string | null;
- /** Format: date-time */
- readonly created_at: string | null;
- /** Format: uri */
- readonly discussion_url?: string;
- /** @description Whether the release is a draft or published */
- readonly draft: boolean;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly node_id: string;
- /** @description Whether the release is identified as a prerelease or a full release. */
- readonly prerelease: boolean;
- /** Format: date-time */
- readonly published_at: string | null;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** @description The name of the tag. */
- readonly tag_name: string;
- /** Format: uri */
- readonly tarball_url: string | null;
- /** @description Specifies the commitish value that determines where the Git tag is created from. */
- readonly target_commitish: string;
- /** Format: uri-template */
- readonly upload_url: string;
- /** Format: uri */
- readonly url: string;
- /** Format: uri */
- readonly zipball_url: string | null;
- } & {
- readonly assets?: Record[];
- readonly assets_url?: string;
- readonly author?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly body?: string | null;
- readonly created_at?: string;
- readonly draft?: boolean;
- readonly html_url?: string;
- readonly id?: number;
- readonly name?: string | null;
- readonly node_id?: string;
- /**
- * @description Whether the release is identified as a prerelease or a full release.
- * @enum {boolean}
- */
- readonly prerelease: true;
- readonly published_at?: string | null;
- readonly tag_name?: string;
- readonly tarball_url?: string | null;
- readonly target_commitish?: string;
- readonly upload_url?: string;
- readonly url?: string;
- readonly zipball_url?: string | null;
};
readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** release published event */
- readonly "webhook-release-published": {
+ /** pull_request unlocked event */
+ readonly "webhook-pull-request-unlocked": {
/** @enum {string} */
- readonly action: "published";
+ readonly action: "unlocked";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
+ readonly number: components["schemas"]["webhooks_number"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly release: {
- readonly assets: {
- /** Format: uri */
- readonly browser_download_url: string;
- readonly content_type: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly download_count: number;
- readonly id: number;
- readonly label: string | null;
- /** @description The file name of the asset. */
- readonly name: string;
- readonly node_id: string;
- readonly size: number;
- /**
- * @description State of the release asset.
- * @enum {string}
- */
- readonly state: "uploaded";
- /** Format: date-time */
- readonly updated_at: string;
- /** User */
- readonly uploader?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ /** Pull Request */
+ readonly pull_request: {
+ readonly _links: {
+ /** Link */
+ readonly comments: {
/** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
+ readonly href: string;
+ };
+ /** Link */
+ readonly commits: {
/** Format: uri-template */
- readonly following_url?: string;
+ readonly href: string;
+ };
+ /** Link */
+ readonly html: {
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ readonly href: string;
+ };
+ /** Link */
+ readonly issue: {
/** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: uri */
- readonly url: string;
- }[];
- /** Format: uri */
- readonly assets_url: string;
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comment: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comments: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly self: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly statuses: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ };
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly additions?: number;
/** User */
- readonly author: {
+ readonly assignee: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -84844,125 +77470,59 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- readonly body: string | null;
- /** Format: date-time */
- readonly created_at: string | null;
- /** Format: uri */
- readonly discussion_url?: string;
- /** @description Whether the release is a draft or published */
- readonly draft: boolean;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly node_id: string;
- /** @description Whether the release is identified as a prerelease or a full release. */
- readonly prerelease: boolean;
- /** Format: date-time */
- readonly published_at: string | null;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
+ readonly assignees: ({
/** Format: uri */
- readonly url: string;
- };
- /** @description The name of the tag. */
- readonly tag_name: string;
- /** Format: uri */
- readonly tarball_url: string | null;
- /** @description Specifies the commitish value that determines where the Git tag is created from. */
- readonly target_commitish: string;
- /** Format: uri-template */
- readonly upload_url: string;
- /** Format: uri */
- readonly url: string;
- /** Format: uri */
- readonly zipball_url: string | null;
- } & {
- readonly assets?: Record[];
- readonly assets_url?: string;
- readonly author?: {
readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
readonly events_url?: string;
+ /** Format: uri */
readonly followers_url?: string;
+ /** Format: uri-template */
readonly following_url?: string;
+ /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
+ /** Format: uri */
readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
readonly node_id?: string;
+ /** Format: uri */
readonly organizations_url?: string;
+ /** Format: uri */
readonly received_events_url?: string;
+ /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
+ /** Format: uri-template */
readonly starred_url?: string;
+ /** Format: uri */
readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly body?: string | null;
- readonly created_at?: string;
- readonly draft?: boolean;
- readonly html_url?: string;
- readonly id?: number;
- readonly name?: string | null;
- readonly node_id?: string;
- readonly prerelease?: boolean;
- /** Format: date-time */
- readonly published_at: string | null;
- readonly tag_name?: string;
- readonly tarball_url?: string | null;
- readonly target_commitish?: string;
- readonly upload_url?: string;
- readonly url?: string;
- readonly zipball_url?: string | null;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** release released event */
- readonly "webhook-release-released": {
- /** @enum {string} */
- readonly action: "released";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /**
- * Release
- * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
- */
- readonly release: {
- readonly assets: {
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly browser_download_url: string;
- readonly content_type: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly download_count: number;
- readonly id: number;
- readonly label: string | null;
- /** @description The file name of the asset. */
- readonly name: string;
- readonly node_id: string;
- readonly size: number;
- /**
- * @description State of the release asset.
- * @enum {string}
- */
- readonly state: "uploaded";
- /** Format: date-time */
- readonly updated_at: string;
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ readonly auto_merge: {
+ /** @description Commit message for the merge commit. */
+ readonly commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ readonly commit_title: string;
/** User */
- readonly uploader?: {
+ readonly enabled_by: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -84992,130 +77552,305 @@ export type components = {
/** Format: uri-template */
readonly starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ readonly merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ readonly base: {
+ readonly label: string;
+ readonly ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ readonly repo: {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow private forks */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ readonly allow_rebase_merge: boolean;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ readonly allow_squash_merge: boolean;
+ readonly allow_update_branch?: boolean;
+ /** Format: uri-template */
+ readonly archive_url: string;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
+ /** Format: uri-template */
+ readonly assignees_url: string;
+ /** Format: uri-template */
+ readonly blobs_url: string;
+ /** Format: uri-template */
+ readonly branches_url: string;
+ /** Format: uri */
+ readonly clone_url: string;
+ /** Format: uri-template */
+ readonly collaborators_url: string;
+ /** Format: uri-template */
+ readonly comments_url: string;
+ /** Format: uri-template */
+ readonly commits_url: string;
+ /** Format: uri-template */
+ readonly compare_url: string;
+ /** Format: uri-template */
+ readonly contents_url: string;
+ /** Format: uri */
+ readonly contributors_url: string;
+ readonly created_at: number | string;
+ /** @description The default branch of the repository. */
+ readonly default_branch: string;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /** Format: uri */
+ readonly deployments_url: string;
+ readonly description: string | null;
+ /** @description Returns whether or not this repository is disabled. */
+ readonly disabled?: boolean;
+ /** Format: uri */
+ readonly downloads_url: string;
+ /** Format: uri */
+ readonly events_url: string;
+ readonly fork: boolean;
+ readonly forks: number;
+ readonly forks_count: number;
+ /** Format: uri */
+ readonly forks_url: string;
+ readonly full_name: string;
+ /** Format: uri-template */
+ readonly git_commits_url: string;
+ /** Format: uri-template */
+ readonly git_refs_url: string;
+ /** Format: uri-template */
+ readonly git_tags_url: string;
+ /** Format: uri */
+ readonly git_url: string;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ readonly has_issues: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ readonly has_wiki: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ readonly has_discussions: boolean;
+ readonly homepage: string | null;
+ /** Format: uri */
+ readonly hooks_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ readonly is_template?: boolean;
+ /** Format: uri-template */
+ readonly issue_comment_url: string;
+ /** Format: uri-template */
+ readonly issue_events_url: string;
+ /** Format: uri-template */
+ readonly issues_url: string;
+ /** Format: uri-template */
+ readonly keys_url: string;
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly language: string | null;
+ /** Format: uri */
+ readonly languages_url: string;
+ /** License */
+ readonly license: {
+ readonly key: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly spdx_id: string;
+ /** Format: uri */
+ readonly url: string | null;
+ } | null;
+ readonly master_branch?: string;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** Format: uri */
+ readonly merges_url: string;
+ /** Format: uri-template */
+ readonly milestones_url: string;
+ /** Format: uri */
+ readonly mirror_url: string | null;
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** Format: uri-template */
+ readonly notifications_url: string;
+ readonly open_issues: number;
+ readonly open_issues_count: number;
+ readonly organization?: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly pull: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
+ };
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ readonly public?: boolean;
+ /** Format: uri-template */
+ readonly pulls_url: string;
+ readonly pushed_at: (number | string) | null;
+ /** Format: uri-template */
+ readonly releases_url: string;
+ readonly role_name?: string | null;
+ readonly size: number;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly ssh_url: string;
+ readonly stargazers?: number;
+ readonly stargazers_count: number;
+ /** Format: uri */
+ readonly stargazers_url: string;
+ /** Format: uri-template */
+ readonly statuses_url: string;
+ /** Format: uri */
+ readonly subscribers_url: string;
+ /** Format: uri */
+ readonly subscription_url: string;
+ /** Format: uri */
+ readonly svn_url: string;
+ /** Format: uri */
+ readonly tags_url: string;
+ /** Format: uri */
+ readonly teams_url: string;
+ readonly topics: string[];
+ /** Format: uri-template */
+ readonly trees_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: uri */
- readonly url: string;
- }[];
- /** Format: uri */
- readonly assets_url: string;
- /** User */
- readonly author: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly body: string | null;
- /** Format: date-time */
- readonly created_at: string | null;
- /** Format: uri */
- readonly discussion_url?: string;
- /** @description Whether the release is a draft or published */
- readonly draft: boolean;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly node_id: string;
- /** @description Whether the release is identified as a prerelease or a full release. */
- readonly prerelease: boolean;
- /** Format: date-time */
- readonly published_at: string | null;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** @description The name of the tag. */
- readonly tag_name: string;
- /** Format: uri */
- readonly tarball_url: string | null;
- /** @description Specifies the commitish value that determines where the Git tag is created from. */
- readonly target_commitish: string;
- /** Format: uri-template */
- readonly upload_url: string;
- /** Format: uri */
- readonly url: string;
- /** Format: uri */
- readonly zipball_url: string | null;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** release unpublished event */
- readonly "webhook-release-unpublished": {
- /** @enum {string} */
- readonly action: "unpublished";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly release: {
- readonly assets: {
- /** Format: uri */
- readonly browser_download_url: string;
- readonly content_type: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly download_count: number;
- readonly id: number;
- readonly label: string | null;
- /** @description The file name of the asset. */
- readonly name: string;
- readonly node_id: string;
- readonly size: number;
- /**
- * @description State of the release asset.
- * @enum {string}
- */
- readonly state: "uploaded";
- /** Format: date-time */
- readonly updated_at: string;
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
+ };
+ readonly sha: string;
/** User */
- readonly uploader?: {
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -85131,403 +77866,223 @@ export type components = {
readonly gravatar_id?: string;
/** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: uri */
- readonly url: string;
- }[];
- /** Format: uri */
- readonly assets_url: string;
- /** User */
- readonly author: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly body: string | null;
- /** Format: date-time */
- readonly created_at: string | null;
- /** Format: uri */
- readonly discussion_url?: string;
- /** @description Whether the release is a draft or published */
- readonly draft: boolean;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly node_id: string;
- /** @description Whether the release is identified as a prerelease or a full release. */
- readonly prerelease: boolean;
- /** Format: date-time */
- readonly published_at: string | null;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** @description The name of the tag. */
- readonly tag_name: string;
- /** Format: uri */
- readonly tarball_url: string | null;
- /** @description Specifies the commitish value that determines where the Git tag is created from. */
- readonly target_commitish: string;
- /** Format: uri-template */
- readonly upload_url: string;
- /** Format: uri */
- readonly url: string;
- /** Format: uri */
- readonly zipball_url: string | null;
- } & {
- readonly assets?: Record[];
- readonly assets_url?: string;
- readonly author?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly body?: string | null;
- readonly created_at?: string;
- readonly draft?: boolean;
- readonly html_url?: string;
- readonly id?: number;
- readonly name?: string | null;
- readonly node_id?: string;
- readonly prerelease?: boolean;
- readonly published_at: string | null;
- readonly tag_name?: string;
- readonly tarball_url?: string | null;
- readonly target_commitish?: string;
- readonly upload_url?: string;
- readonly url?: string;
- readonly zipball_url?: string | null;
- };
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** Repository advisory published event */
- readonly "webhook-repository-advisory-published": {
- /** @enum {string} */
- readonly action: "published";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly repository_advisory: components["schemas"]["repository-advisory"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** Repository advisory reported event */
- readonly "webhook-repository-advisory-reported": {
- /** @enum {string} */
- readonly action: "reported";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly repository_advisory: components["schemas"]["repository-advisory"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** repository archived event */
- readonly "webhook-repository-archived": {
- /** @enum {string} */
- readonly action: "archived";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository created event */
- readonly "webhook-repository-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository deleted event */
- readonly "webhook-repository-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository_dispatch event */
- readonly "webhook-repository-dispatch-sample": {
- /** @enum {string} */
- readonly action: "sample.collected";
- readonly branch: string;
- readonly client_payload: {
- readonly [key: string]: unknown;
- } | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository edited event */
- readonly "webhook-repository-edited": {
- /** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly default_branch?: {
- readonly from: string;
- };
- readonly description?: {
- readonly from: string | null;
- };
- readonly homepage?: {
- readonly from: string | null;
- };
- readonly topics?: {
- readonly from?: string[] | null;
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository_import event */
- readonly "webhook-repository-import": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- /** @enum {string} */
- readonly status: "success" | "cancelled" | "failure";
- };
- /** repository privatized event */
- readonly "webhook-repository-privatized": {
- /** @enum {string} */
- readonly action: "privatized";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository publicized event */
- readonly "webhook-repository-publicized": {
- /** @enum {string} */
- readonly action: "publicized";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository renamed event */
- readonly "webhook-repository-renamed": {
- /** @enum {string} */
- readonly action: "renamed";
- readonly changes: {
- readonly repository: {
- readonly name: {
- readonly from: string;
- };
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository ruleset created event */
- readonly "webhook-repository-ruleset-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly repository_ruleset: components["schemas"]["repository-ruleset"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository ruleset deleted event */
- readonly "webhook-repository-ruleset-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly repository_ruleset: components["schemas"]["repository-ruleset"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository ruleset edited event */
- readonly "webhook-repository-ruleset-edited": {
- /** @enum {string} */
- readonly action: "edited";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly repository_ruleset: components["schemas"]["repository-ruleset"];
- readonly changes?: {
- readonly name?: {
- readonly from?: string;
- };
- readonly enforcement?: {
- readonly from?: string;
- };
- readonly conditions?: {
- readonly added?: components["schemas"]["repository-ruleset-conditions"][];
- readonly deleted?: components["schemas"]["repository-ruleset-conditions"][];
- readonly updated?: {
- readonly condition?: components["schemas"]["repository-ruleset-conditions"];
- readonly changes?: {
- readonly condition_type?: {
- readonly from?: string;
- };
- readonly target?: {
- readonly from?: string;
- };
- readonly include?: {
- readonly from?: string[];
- };
- readonly exclude?: {
- readonly from?: string[];
- };
- };
- }[];
- };
- readonly rules?: {
- readonly added?: components["schemas"]["repository-rule"][];
- readonly deleted?: components["schemas"]["repository-rule"][];
- readonly updated?: {
- readonly rule?: components["schemas"]["repository-rule"];
- readonly changes?: {
- readonly configuration?: {
- readonly from?: string;
- };
- readonly rule_type?: {
- readonly from?: string;
- };
- readonly pattern?: {
- readonly from?: string;
- };
- };
- }[];
- };
- };
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository transferred event */
- readonly "webhook-repository-transferred": {
- /** @enum {string} */
- readonly action: "transferred";
- readonly changes: {
- readonly owner: {
- readonly from: {
- /** Organization */
- readonly organization?: {
- /** Format: uri */
- readonly avatar_url: string;
- readonly description: string | null;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly hooks_url: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- /** Format: uri */
- readonly issues_url: string;
- readonly login: string;
- /** Format: uri-template */
- readonly members_url: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ readonly body: string | null;
+ readonly changed_files?: number;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments?: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ readonly commits?: number;
+ /** Format: uri */
+ readonly commits_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly deletions?: number;
+ /** Format: uri */
+ readonly diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ readonly draft: boolean;
+ readonly head: {
+ readonly label: string;
+ readonly ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ readonly repo: {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow private forks */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ readonly allow_rebase_merge: boolean;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ readonly allow_squash_merge: boolean;
+ readonly allow_update_branch?: boolean;
+ /** Format: uri-template */
+ readonly archive_url: string;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
+ /** Format: uri-template */
+ readonly assignees_url: string;
+ /** Format: uri-template */
+ readonly blobs_url: string;
+ /** Format: uri-template */
+ readonly branches_url: string;
+ /** Format: uri */
+ readonly clone_url: string;
+ /** Format: uri-template */
+ readonly collaborators_url: string;
+ /** Format: uri-template */
+ readonly comments_url: string;
+ /** Format: uri-template */
+ readonly commits_url: string;
+ /** Format: uri-template */
+ readonly compare_url: string;
+ /** Format: uri-template */
+ readonly contents_url: string;
+ /** Format: uri */
+ readonly contributors_url: string;
+ readonly created_at: number | string;
+ /** @description The default branch of the repository. */
+ readonly default_branch: string;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /** Format: uri */
+ readonly deployments_url: string;
+ readonly description: string | null;
+ /** @description Returns whether or not this repository is disabled. */
+ readonly disabled?: boolean;
+ /** Format: uri */
+ readonly downloads_url: string;
+ /** Format: uri */
+ readonly events_url: string;
+ readonly fork: boolean;
+ readonly forks: number;
+ readonly forks_count: number;
+ /** Format: uri */
+ readonly forks_url: string;
+ readonly full_name: string;
+ /** Format: uri-template */
+ readonly git_commits_url: string;
+ /** Format: uri-template */
+ readonly git_refs_url: string;
+ /** Format: uri-template */
+ readonly git_tags_url: string;
+ /** Format: uri */
+ readonly git_url: string;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ readonly has_issues: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ readonly has_wiki: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ readonly has_discussions: boolean;
+ readonly homepage: string | null;
+ /** Format: uri */
+ readonly hooks_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ readonly is_template?: boolean;
+ /** Format: uri-template */
+ readonly issue_comment_url: string;
+ /** Format: uri-template */
+ readonly issue_events_url: string;
+ /** Format: uri-template */
+ readonly issues_url: string;
+ /** Format: uri-template */
+ readonly keys_url: string;
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly language: string | null;
+ /** Format: uri */
+ readonly languages_url: string;
+ /** License */
+ readonly license: {
+ readonly key: string;
+ readonly name: string;
readonly node_id: string;
- /** Format: uri-template */
- readonly public_members_url: string;
- /** Format: uri */
- readonly repos_url: string;
+ readonly spdx_id: string;
/** Format: uri */
- readonly url: string;
- };
+ readonly url: string | null;
+ } | null;
+ readonly master_branch?: string;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** Format: uri */
+ readonly merges_url: string;
+ /** Format: uri-template */
+ readonly milestones_url: string;
+ /** Format: uri */
+ readonly mirror_url: string | null;
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** Format: uri-template */
+ readonly notifications_url: string;
+ readonly open_issues: number;
+ readonly open_issues_count: number;
+ readonly organization?: string;
/** User */
- readonly user?: {
+ readonly owner: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -85563,324 +78118,146 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- };
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository unarchived event */
- readonly "webhook-repository-unarchived": {
- /** @enum {string} */
- readonly action: "unarchived";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository_vulnerability_alert create event */
- readonly "webhook-repository-vulnerability-alert-create": {
- /** @enum {string} */
- readonly action: "create";
- readonly alert: {
- readonly affected_package_name: string;
- readonly affected_range: string;
- readonly created_at: string;
- readonly dismiss_reason?: string;
- readonly dismissed_at?: string;
- /** User */
- readonly dismisser?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly external_identifier: string;
- /** Format: uri */
- readonly external_reference: string | null;
- readonly fix_reason?: string;
- /** Format: date-time */
- readonly fixed_at?: string;
- readonly fixed_in?: string;
- readonly ghsa_id: string;
- readonly id: number;
- readonly node_id: string;
- readonly number: number;
- readonly severity: string;
- /** @enum {string} */
- readonly state: "open" | "dismissed" | "fixed";
- } & {
- readonly affected_package_name?: string;
- readonly affected_range?: string;
- readonly created_at?: string;
- readonly external_identifier?: string;
- readonly external_reference?: string | null;
- readonly fixed_in?: string;
- readonly ghsa_id?: string;
- readonly id?: number;
- readonly node_id?: string;
- readonly number?: number;
- readonly severity?: string;
- /** @enum {string} */
- readonly state: "open";
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository_vulnerability_alert dismiss event */
- readonly "webhook-repository-vulnerability-alert-dismiss": {
- /** @enum {string} */
- readonly action: "dismiss";
- readonly alert: {
- readonly affected_package_name: string;
- readonly affected_range: string;
- readonly created_at: string;
- readonly dismiss_comment?: string | null;
- readonly dismiss_reason?: string;
- readonly dismissed_at?: string;
- /** User */
- readonly dismisser?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly external_identifier: string;
- /** Format: uri */
- readonly external_reference: string | null;
- readonly fix_reason?: string;
- /** Format: date-time */
- readonly fixed_at?: string;
- readonly fixed_in?: string;
- readonly ghsa_id: string;
- readonly id: number;
- readonly node_id: string;
- readonly number: number;
- readonly severity: string;
- /** @enum {string} */
- readonly state: "open" | "dismissed" | "fixed";
- } & {
- readonly affected_package_name?: string;
- readonly affected_range?: string;
- readonly created_at?: string;
- readonly dismiss_comment?: string | null;
- readonly dismiss_reason: string;
- readonly dismissed_at: string;
- /** User */
- readonly dismisser: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly external_identifier?: string;
- readonly external_reference?: string | null;
- readonly fixed_in?: string;
- readonly ghsa_id?: string;
- readonly id?: number;
- readonly node_id?: string;
- readonly number?: number;
- readonly severity?: string;
- /** @enum {string} */
- readonly state: "dismissed";
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository_vulnerability_alert reopen event */
- readonly "webhook-repository-vulnerability-alert-reopen": {
- /** @enum {string} */
- readonly action: "reopen";
- readonly alert: {
- readonly affected_package_name: string;
- readonly affected_range: string;
- readonly created_at: string;
- readonly dismiss_reason?: string;
- readonly dismissed_at?: string;
- /** User */
- readonly dismisser?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly external_identifier: string;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly pull: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
+ };
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ readonly public?: boolean;
+ /** Format: uri-template */
+ readonly pulls_url: string;
+ readonly pushed_at: (number | string) | null;
+ /** Format: uri-template */
+ readonly releases_url: string;
+ readonly role_name?: string | null;
+ readonly size: number;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly ssh_url: string;
+ readonly stargazers?: number;
+ readonly stargazers_count: number;
+ /** Format: uri */
+ readonly stargazers_url: string;
+ /** Format: uri-template */
+ readonly statuses_url: string;
+ /** Format: uri */
+ readonly subscribers_url: string;
+ /** Format: uri */
+ readonly subscription_url: string;
+ /** Format: uri */
+ readonly svn_url: string;
+ /** Format: uri */
+ readonly tags_url: string;
+ /** Format: uri */
+ readonly teams_url: string;
+ readonly topics: string[];
+ /** Format: uri-template */
+ readonly trees_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
+ /** @enum {string} */
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
+ } | null;
+ readonly sha: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
/** Format: uri */
- readonly external_reference: string | null;
- readonly fix_reason?: string;
- /** Format: date-time */
- readonly fixed_at?: string;
- readonly fixed_in?: string;
- readonly ghsa_id: string;
+ readonly html_url: string;
readonly id: number;
- readonly node_id: string;
- readonly number: number;
- readonly severity: string;
- /** @enum {string} */
- readonly state: "open" | "dismissed" | "fixed";
- } & {
- readonly affected_package_name?: string;
- readonly affected_range?: string;
- readonly created_at?: string;
- readonly external_identifier?: string;
- readonly external_reference?: string | null;
- readonly fixed_in?: string;
- readonly ghsa_id?: string;
- readonly id?: number;
- readonly node_id?: string;
- readonly number?: number;
- readonly severity?: string;
- /** @enum {string} */
- readonly state: "open";
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** repository_vulnerability_alert resolve event */
- readonly "webhook-repository-vulnerability-alert-resolve": {
- /** @enum {string} */
- readonly action: "resolve";
- readonly alert: {
- readonly affected_package_name: string;
- readonly affected_range: string;
- readonly created_at: string;
- readonly dismiss_reason?: string;
- readonly dismissed_at?: string;
+ /** Format: uri */
+ readonly issue_url: string;
+ readonly labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ readonly locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ readonly maintainer_can_modify?: boolean;
+ readonly merge_commit_sha: string | null;
+ readonly mergeable?: boolean | null;
+ readonly mergeable_state?: string;
+ readonly merged?: boolean | null;
+ /** Format: date-time */
+ readonly merged_at: string | null;
/** User */
- readonly dismisser?: {
+ readonly merged_by?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -85916,330 +78293,84 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- readonly external_identifier: string;
- /** Format: uri */
- readonly external_reference: string | null;
- readonly fix_reason?: string;
- /** Format: date-time */
- readonly fixed_at?: string;
- readonly fixed_in?: string;
- readonly ghsa_id: string;
- readonly id: number;
- readonly node_id: string;
- readonly number: number;
- readonly severity: string;
- /** @enum {string} */
- readonly state: "open" | "dismissed" | "fixed";
- } & {
- readonly affected_package_name?: string;
- readonly affected_range?: string;
- readonly created_at?: string;
- readonly external_identifier?: string;
- readonly external_reference?: string | null;
- readonly fix_reason?: string;
- /** Format: date-time */
- readonly fixed_at?: string;
- readonly fixed_in?: string;
- readonly ghsa_id?: string;
- readonly id?: number;
- readonly node_id?: string;
- readonly number?: number;
- readonly severity?: string;
- /** @enum {string} */
- readonly state: "fixed" | "open";
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** secret_scanning_alert created event */
- readonly "webhook-secret-scanning-alert-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** Secret Scanning Alert Location Created Event */
- readonly "webhook-secret-scanning-alert-location-created": {
- /** @enum {string} */
- readonly action?: "created";
- readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly location: components["schemas"]["secret-scanning-location"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Secret Scanning Alert Location Created Event */
- readonly "webhook-secret-scanning-alert-location-created-form-encoded": {
- /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
- };
- /** secret_scanning_alert reopened event */
- readonly "webhook-secret-scanning-alert-reopened": {
- /** @enum {string} */
- readonly action: "reopened";
- readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** secret_scanning_alert resolved event */
- readonly "webhook-secret-scanning-alert-resolved": {
- /** @enum {string} */
- readonly action: "resolved";
- readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** secret_scanning_alert revoked event */
- readonly "webhook-secret-scanning-alert-revoked": {
- /** @enum {string} */
- readonly action: "revoked";
- readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** security_advisory published event */
- readonly "webhook-security-advisory-published": {
- /** @enum {string} */
- readonly action: "published";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- /** @description The details of the security advisory, including summary, description, and severity. */
- readonly security_advisory: {
- readonly cvss: {
- readonly score: number;
- readonly vector_string: string | null;
- };
- readonly cwes: {
- readonly cwe_id: string;
- readonly name: string;
- }[];
- readonly description: string;
- readonly ghsa_id: string;
- readonly identifiers: {
- readonly type: string;
- readonly value: string;
- }[];
- readonly published_at: string;
- readonly references: {
- /** Format: uri */
- readonly url: string;
- }[];
- readonly severity: string;
- readonly summary: string;
- readonly updated_at: string;
- readonly vulnerabilities: {
- readonly first_patched_version: {
- readonly identifier: string;
- } | null;
- readonly package: {
- readonly ecosystem: string;
- readonly name: string;
- };
- readonly severity: string;
- readonly vulnerable_version_range: string;
- }[];
- readonly withdrawn_at: string | null;
- };
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** security_advisory updated event */
- readonly "webhook-security-advisory-updated": {
- /** @enum {string} */
- readonly action: "updated";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- /** @description The details of the security advisory, including summary, description, and severity. */
- readonly security_advisory: {
- readonly cvss: {
- readonly score: number;
- readonly vector_string: string | null;
- };
- readonly cwes: {
- readonly cwe_id: string;
- readonly name: string;
- }[];
- readonly description: string;
- readonly ghsa_id: string;
- readonly identifiers: {
- readonly type: string;
- readonly value: string;
- }[];
- readonly published_at: string;
- readonly references: {
- /** Format: uri */
- readonly url: string;
- }[];
- readonly severity: string;
- readonly summary: string;
- readonly updated_at: string;
- readonly vulnerabilities: {
- readonly first_patched_version: {
- readonly identifier: string;
- } | null;
- readonly package: {
- readonly ecosystem: string;
- readonly name: string;
- };
- readonly severity: string;
- readonly vulnerable_version_range: string;
- }[];
- readonly withdrawn_at: string | null;
- };
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** security_advisory withdrawn event */
- readonly "webhook-security-advisory-withdrawn": {
- /** @enum {string} */
- readonly action: "withdrawn";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- /** @description The details of the security advisory, including summary, description, and severity. */
- readonly security_advisory: {
- readonly cvss: {
- readonly score: number;
- readonly vector_string: string | null;
- };
- readonly cwes: {
- readonly cwe_id: string;
- readonly name: string;
- }[];
- readonly description: string;
- readonly ghsa_id: string;
- readonly identifiers: {
- readonly type: string;
- readonly value: string;
- }[];
- readonly published_at: string;
- readonly references: {
- /** Format: uri */
- readonly url: string;
- }[];
- readonly severity: string;
- readonly summary: string;
- readonly updated_at: string;
- readonly vulnerabilities: {
- readonly first_patched_version: {
- readonly identifier: string;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
} | null;
- readonly package: {
- readonly ecosystem: string;
- readonly name: string;
- };
- readonly severity: string;
- readonly vulnerable_version_range: string;
- }[];
- readonly withdrawn_at: string;
- };
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** security_and_analysis event */
- readonly "webhook-security-and-analysis": {
- readonly changes: {
- readonly from?: {
- readonly security_and_analysis?: components["schemas"]["security-and-analysis"];
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["full-repository"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** sponsorship cancelled event */
- readonly "webhook-sponsorship-cancelled": {
- /** @enum {string} */
- readonly action: "cancelled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly sponsorship: {
- readonly created_at: string;
- readonly maintainer?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly node_id: string;
- readonly privacy_level: string;
- /** User */
- readonly sponsor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
/** Format: uri */
- readonly html_url?: string;
+ readonly html_url: string;
readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
/** Format: uri */
- readonly url?: string;
+ readonly url: string;
} | null;
- /** User */
- readonly sponsorable: {
+ readonly node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ readonly number: number;
+ /** Format: uri */
+ readonly patch_url: string;
+ readonly rebaseable?: boolean | null;
+ readonly requested_reviewers: (({
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -86274,96 +78405,128 @@ export type components = {
readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null;
- /**
- * Sponsorship Tier
- * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
- */
- readonly tier: {
- readonly created_at: string;
- readonly description: string;
- readonly is_custom_ammount?: boolean;
- readonly is_custom_amount?: boolean;
- readonly is_one_time: boolean;
- readonly monthly_price_in_cents: number;
- readonly monthly_price_in_dollars: number;
- readonly name: string;
- readonly node_id: string;
- };
- };
- };
- /** sponsorship created event */
- readonly "webhook-sponsorship-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly sponsorship: {
- readonly created_at: string;
- readonly maintainer?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly node_id: string;
- readonly privacy_level: string;
- /** User */
- readonly sponsor: {
- /** Format: uri */
- readonly avatar_url?: string;
+ } | null) | {
readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ /** @description Description of the team */
+ readonly description?: string | null;
/** Format: uri */
readonly html_url?: string;
+ /** @description Unique identifier of the team */
readonly id: number;
- readonly login: string;
- readonly name?: string;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
+ /** @enum {string} */
+ readonly privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url?: string;
+ })[];
+ readonly requested_teams: {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
/** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly privacy?: "open" | "closed" | "secret";
/** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
readonly url?: string;
- } | null;
+ }[];
+ /** Format: uri-template */
+ readonly review_comment_url: string;
+ readonly review_comments?: number;
+ /** Format: uri */
+ readonly review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** Format: uri */
+ readonly statuses_url: string;
+ /** @description The title of the pull request. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
/** User */
- readonly sponsorable: {
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -86399,64 +78562,308 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
+ };
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** push event */
+ readonly "webhook-push": {
+ /** @description The SHA of the most recent commit on `ref` after the push. */
+ readonly after: string;
+ readonly base_ref: components["schemas"]["webhooks_nullable_string"];
+ /** @description The SHA of the most recent commit on `ref` before the push. */
+ readonly 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 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. */
+ readonly commits: {
+ /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */
+ readonly added?: string[];
/**
- * Sponsorship Tier
- * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
+ * Committer
+ * @description Metaproperties for Git author/committer information.
*/
- readonly tier: {
- readonly created_at: string;
- readonly description: string;
- readonly is_custom_ammount?: boolean;
- readonly is_custom_amount?: boolean;
- readonly is_one_time: boolean;
- readonly monthly_price_in_cents: number;
- readonly monthly_price_in_dollars: number;
+ readonly author: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
readonly name: string;
- readonly node_id: string;
+ readonly username?: string;
};
- };
- };
- /** sponsorship edited event */
- readonly "webhook-sponsorship-edited": {
- /** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly privacy_level?: {
- /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */
- readonly from: string;
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly committer: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
};
- };
+ /** @description Whether this commit is distinct from any that have been pushed before. */
+ readonly distinct: boolean;
+ readonly id: string;
+ /** @description The commit message. */
+ readonly message: string;
+ /** @description An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit. */
+ readonly modified?: string[];
+ /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */
+ readonly removed?: string[];
+ /**
+ * Format: date-time
+ * @description The ISO 8601 timestamp of the commit.
+ */
+ readonly timestamp: string;
+ readonly tree_id: string;
+ /**
+ * Format: uri
+ * @description URL that points to the commit API resource.
+ */
+ readonly url: string;
+ }[];
+ /** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */
+ readonly compare: string;
+ /** @description Whether this push created the `ref`. */
+ readonly created: boolean;
+ /** @description Whether this push deleted the `ref`. */
+ readonly deleted: boolean;
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ /** @description Whether this push was a force push of the `ref`. */
+ readonly forced: boolean;
+ /** Commit */
+ readonly head_commit: {
+ /** @description An array of files added in the commit. */
+ readonly added?: string[];
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly author: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly committer: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ /** @description Whether this commit is distinct from any that have been pushed before. */
+ readonly distinct: boolean;
+ readonly id: string;
+ /** @description The commit message. */
+ readonly message: string;
+ /** @description An array of files modified by the commit. */
+ readonly modified?: string[];
+ /** @description An array of files removed in the commit. */
+ readonly removed?: string[];
+ /**
+ * Format: date-time
+ * @description The ISO 8601 timestamp of the commit.
+ */
+ readonly timestamp: string;
+ readonly tree_id: string;
+ /**
+ * Format: uri
+ * @description URL that points to the commit API resource.
+ */
+ readonly url: string;
+ } | null;
readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly sponsorship: {
- readonly created_at: string;
- readonly maintainer?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly pusher: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email?: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ /** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */
+ readonly ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ readonly repository: {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow private forks */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ readonly allow_rebase_merge: boolean;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ readonly allow_squash_merge: boolean;
+ readonly allow_update_branch?: boolean;
+ /** Format: uri-template */
+ readonly archive_url: string;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
+ /** Format: uri-template */
+ readonly assignees_url: string;
+ /** Format: uri-template */
+ readonly blobs_url: string;
+ /** Format: uri-template */
+ readonly branches_url: string;
+ /** Format: uri */
+ readonly clone_url: string;
+ /** Format: uri-template */
+ readonly collaborators_url: string;
+ /** Format: uri-template */
+ readonly comments_url: string;
+ /** Format: uri-template */
+ readonly commits_url: string;
+ /** Format: uri-template */
+ readonly compare_url: string;
+ /** Format: uri-template */
+ readonly contents_url: string;
+ /** Format: uri */
+ readonly contributors_url: string;
+ readonly created_at: number | string;
+ /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
+ readonly custom_properties?: {
+ readonly [key: string]: unknown;
};
+ /** @description The default branch of the repository. */
+ readonly default_branch: string;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /** Format: uri */
+ readonly deployments_url: string;
+ readonly description: string | null;
+ /** @description Returns whether or not this repository is disabled. */
+ readonly disabled?: boolean;
+ /** Format: uri */
+ readonly downloads_url: string;
+ /** Format: uri */
+ readonly events_url: string;
+ readonly fork: boolean;
+ readonly forks: number;
+ readonly forks_count: number;
+ /** Format: uri */
+ readonly forks_url: string;
+ readonly full_name: string;
+ /** Format: uri-template */
+ readonly git_commits_url: string;
+ /** Format: uri-template */
+ readonly git_refs_url: string;
+ /** Format: uri-template */
+ readonly git_tags_url: string;
+ /** Format: uri */
+ readonly git_url: string;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ readonly has_issues: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ readonly has_wiki: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ readonly has_discussions: boolean;
+ readonly homepage: string | null;
+ /** Format: uri */
+ readonly hooks_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ readonly is_template?: boolean;
+ /** Format: uri-template */
+ readonly issue_comment_url: string;
+ /** Format: uri-template */
+ readonly issue_events_url: string;
+ /** Format: uri-template */
+ readonly issues_url: string;
+ /** Format: uri-template */
+ readonly keys_url: string;
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly language: string | null;
+ /** Format: uri */
+ readonly languages_url: string;
+ /** License */
+ readonly license: {
+ readonly key: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly spdx_id: string;
+ /** Format: uri */
+ readonly url: string | null;
+ } | null;
+ readonly master_branch?: string;
+ /** Format: uri */
+ readonly merges_url: string;
+ /** Format: uri-template */
+ readonly milestones_url: string;
+ /** Format: uri */
+ readonly mirror_url: string | null;
+ /** @description The name of the repository. */
+ readonly name: string;
readonly node_id: string;
- readonly privacy_level: string;
+ /** Format: uri-template */
+ readonly notifications_url: string;
+ readonly open_issues: number;
+ readonly open_issues_count: number;
+ readonly organization?: string;
/** User */
- readonly sponsor: {
+ readonly owner: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -86492,134 +78899,508 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- /** User */
- readonly sponsorable: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly pull: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
+ };
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ readonly public?: boolean;
+ /** Format: uri-template */
+ readonly pulls_url: string;
+ readonly pushed_at: (number | string) | null;
+ /** Format: uri-template */
+ readonly releases_url: string;
+ readonly role_name?: string | null;
+ readonly size: number;
+ readonly ssh_url: string;
+ readonly stargazers?: number;
+ readonly stargazers_count: number;
+ /** Format: uri */
+ readonly stargazers_url: string;
+ /** Format: uri-template */
+ readonly statuses_url: string;
+ /** Format: uri */
+ readonly subscribers_url: string;
+ /** Format: uri */
+ readonly subscription_url: string;
+ /** Format: uri */
+ readonly svn_url: string;
+ /** Format: uri */
+ readonly tags_url: string;
+ /** Format: uri */
+ readonly teams_url: string;
+ readonly topics: string[];
+ /** Format: uri-template */
+ readonly trees_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ /** @enum {string} */
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
+ };
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ readonly "webhook-registry-package-published": {
+ /** @enum {string} */
+ readonly action: "published";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly registry_package: {
+ readonly created_at: string | null;
+ readonly description: string | null;
+ readonly ecosystem: string;
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string;
+ readonly namespace: string;
+ readonly owner: {
+ readonly avatar_url: string;
+ readonly events_url: string;
+ readonly followers_url: string;
+ readonly following_url: string;
+ readonly gists_url: string;
+ readonly gravatar_id: string;
+ readonly html_url: string;
readonly id: number;
readonly login: string;
+ readonly node_id: string;
+ readonly organizations_url: string;
+ readonly received_events_url: string;
+ readonly repos_url: string;
+ readonly site_admin: boolean;
+ readonly starred_url: string;
+ readonly subscriptions_url: string;
+ readonly type: string;
+ readonly url: string;
+ };
+ readonly package_type: string;
+ readonly package_version: {
+ readonly author?: {
+ readonly avatar_url: string;
+ readonly events_url: string;
+ readonly followers_url: string;
+ readonly following_url: string;
+ readonly gists_url: string;
+ readonly gravatar_id: string;
+ readonly html_url: string;
+ readonly id: number;
+ readonly login: string;
+ readonly node_id: string;
+ readonly organizations_url: string;
+ readonly received_events_url: string;
+ readonly repos_url: string;
+ readonly site_admin: boolean;
+ readonly starred_url: string;
+ readonly subscriptions_url: string;
+ readonly type: string;
+ readonly url: string;
+ };
+ readonly body?: string | Record;
+ readonly body_html?: string;
+ readonly container_metadata?: {
+ readonly labels?: Record;
+ readonly manifest?: Record;
+ readonly tag?: {
+ readonly digest?: string;
+ readonly name?: string;
+ };
+ };
+ readonly created_at?: string;
+ readonly description: string;
+ readonly docker_metadata?: {
+ readonly tags?: string[];
+ }[];
+ readonly draft?: boolean;
+ readonly html_url: string;
+ readonly id: number;
+ readonly installation_command: string;
+ readonly manifest?: string;
+ readonly metadata: {
+ readonly [key: string]: unknown;
+ }[];
+ readonly name: string;
+ readonly npm_metadata?: {
+ readonly name?: string;
+ readonly version?: string;
+ readonly npm_user?: string;
+ readonly author?: (string | Record) | null;
+ readonly bugs?: (string | Record) | null;
+ readonly dependencies?: Record;
+ readonly dev_dependencies?: Record;
+ readonly peer_dependencies?: Record;
+ readonly optional_dependencies?: Record;
+ readonly description?: string;
+ readonly dist?: (string | Record) | null;
+ readonly git_head?: string;
+ readonly homepage?: string;
+ readonly license?: string;
+ readonly main?: string;
+ readonly repository?: (string | Record) | null;
+ readonly scripts?: Record;
+ readonly id?: string;
+ readonly node_version?: string;
+ readonly npm_version?: string;
+ readonly has_shrinkwrap?: boolean;
+ readonly maintainers?: string[];
+ readonly contributors?: string[];
+ readonly engines?: Record;
+ readonly keywords?: string[];
+ readonly files?: string[];
+ readonly bin?: Record;
+ readonly man?: Record;
+ readonly directories?: (string | Record) | null;
+ readonly os?: string[];
+ readonly cpu?: string[];
+ readonly readme?: string;
+ readonly installation_command?: string;
+ readonly release_id?: number;
+ readonly commit_oid?: string;
+ readonly published_via_actions?: boolean;
+ readonly deleted_by_id?: number;
+ } | null;
+ readonly nuget_metadata?: {
+ readonly id?: (string | Record | number) | null;
+ readonly name?: string;
+ readonly value?: boolean | string | number | {
+ readonly url?: string;
+ readonly branch?: string;
+ readonly commit?: string;
+ readonly type?: string;
+ };
+ }[] | null;
+ readonly package_files: {
+ readonly content_type: string;
+ readonly created_at: string;
+ readonly download_url: string;
+ readonly id: number;
+ readonly md5: string | null;
+ readonly name: string;
+ readonly sha1: string | null;
+ readonly sha256: string | null;
+ readonly size: number;
+ readonly state: string | null;
+ readonly updated_at: string;
+ }[];
+ readonly package_url: string;
+ readonly prerelease?: boolean;
+ readonly release?: {
+ readonly author?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
+ readonly created_at?: string;
+ readonly draft?: boolean;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly name?: string | null;
+ readonly prerelease?: boolean;
+ readonly published_at?: string;
+ readonly tag_name?: string;
+ readonly target_commitish?: string;
+ readonly url?: string;
+ };
+ readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
+ readonly summary: string;
+ readonly tag_name?: string;
+ readonly target_commitish?: string;
+ readonly target_oid?: string;
+ readonly updated_at?: string;
+ readonly version: string;
+ } | null;
+ readonly registry: {
+ readonly about_url?: string;
readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
+ readonly type?: string;
readonly url?: string;
+ readonly vendor?: string;
} | null;
- /**
- * Sponsorship Tier
- * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
- */
- readonly tier: {
+ readonly updated_at: string | null;
+ };
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ readonly "webhook-registry-package-updated": {
+ /** @enum {string} */
+ readonly action: "updated";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly registry_package: {
+ readonly created_at: string;
+ readonly description: unknown;
+ readonly ecosystem: string;
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string;
+ readonly namespace: string;
+ readonly owner: {
+ readonly avatar_url: string;
+ readonly events_url: string;
+ readonly followers_url: string;
+ readonly following_url: string;
+ readonly gists_url: string;
+ readonly gravatar_id: string;
+ readonly html_url: string;
+ readonly id: number;
+ readonly login: string;
+ readonly node_id: string;
+ readonly organizations_url: string;
+ readonly received_events_url: string;
+ readonly repos_url: string;
+ readonly site_admin: boolean;
+ readonly starred_url: string;
+ readonly subscriptions_url: string;
+ readonly type: string;
+ readonly url: string;
+ };
+ readonly package_type: string;
+ readonly package_version: {
+ readonly author: {
+ readonly avatar_url: string;
+ readonly events_url: string;
+ readonly followers_url: string;
+ readonly following_url: string;
+ readonly gists_url: string;
+ readonly gravatar_id: string;
+ readonly html_url: string;
+ readonly id: number;
+ readonly login: string;
+ readonly node_id: string;
+ readonly organizations_url: string;
+ readonly received_events_url: string;
+ readonly repos_url: string;
+ readonly site_admin: boolean;
+ readonly starred_url: string;
+ readonly subscriptions_url: string;
+ readonly type: string;
+ readonly url: string;
+ };
+ readonly body: string;
+ readonly body_html: string;
readonly created_at: string;
readonly description: string;
- readonly is_custom_ammount?: boolean;
- readonly is_custom_amount?: boolean;
- readonly is_one_time: boolean;
- readonly monthly_price_in_cents: number;
- readonly monthly_price_in_dollars: number;
+ readonly docker_metadata?: ({
+ readonly tags?: string[];
+ } | null)[];
+ readonly draft?: boolean;
+ readonly html_url: string;
+ readonly id: number;
+ readonly installation_command: string;
+ readonly manifest?: string;
+ readonly metadata: {
+ readonly [key: string]: unknown;
+ }[];
readonly name: string;
- readonly node_id: string;
+ readonly package_files: {
+ readonly content_type?: string;
+ readonly created_at?: string;
+ readonly download_url?: string;
+ readonly id?: number;
+ readonly md5?: string | null;
+ readonly name?: string;
+ readonly sha1?: string | null;
+ readonly sha256?: string;
+ readonly size?: number;
+ readonly state?: string;
+ readonly updated_at?: string;
+ }[];
+ readonly package_url: string;
+ readonly prerelease?: boolean;
+ readonly release?: {
+ readonly author: {
+ readonly avatar_url: string;
+ readonly events_url: string;
+ readonly followers_url: string;
+ readonly following_url: string;
+ readonly gists_url: string;
+ readonly gravatar_id: string;
+ readonly html_url: string;
+ readonly id: number;
+ readonly login: string;
+ readonly node_id: string;
+ readonly organizations_url: string;
+ readonly received_events_url: string;
+ readonly repos_url: string;
+ readonly site_admin: boolean;
+ readonly starred_url: string;
+ readonly subscriptions_url: string;
+ readonly type: string;
+ readonly url: string;
+ };
+ readonly created_at: string;
+ readonly draft: boolean;
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string;
+ readonly prerelease: boolean;
+ readonly published_at: string;
+ readonly tag_name: string;
+ readonly target_commitish: string;
+ readonly url: string;
+ };
+ readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
+ readonly summary: string;
+ readonly tag_name?: string;
+ readonly target_commitish: string;
+ readonly target_oid: string;
+ readonly updated_at: string;
+ readonly version: string;
};
+ readonly registry: Record;
+ readonly updated_at: string;
};
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** sponsorship pending_cancellation event */
- readonly "webhook-sponsorship-pending-cancellation": {
+ /** release created event */
+ readonly "webhook-release-created": {
/** @enum {string} */
- readonly action: "pending_cancellation";
- /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */
- readonly effective_date?: string;
+ readonly action: "created";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly release: components["schemas"]["webhooks_release"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly sponsorship: {
- readonly created_at: string;
- readonly maintainer?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
+ };
+ /** release deleted event */
+ readonly "webhook-release-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly release: components["schemas"]["webhooks_release"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** release edited event */
+ readonly "webhook-release-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ readonly changes: {
+ readonly body?: {
+ /** @description The previous version of the body if the action was `edited`. */
+ readonly from: string;
};
- readonly node_id: string;
- readonly privacy_level: string;
- /** User */
- readonly sponsor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
+ readonly name?: {
+ /** @description The previous version of the name if the action was `edited`. */
+ readonly from: string;
+ };
+ readonly make_latest?: {
+ /** @description Whether this release was explicitly `edited` to be the latest. */
+ readonly to: boolean;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly release: components["schemas"]["webhooks_release"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** release prereleased event */
+ readonly "webhook-release-prereleased": {
+ /** @enum {string} */
+ readonly action: "prereleased";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /**
+ * Release
+ * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
+ */
+ readonly release: {
+ readonly assets: ({
/** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly browser_download_url: string;
+ readonly content_type: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly download_count: number;
+ readonly id: number;
+ readonly label: string | null;
+ /** @description The file name of the asset. */
+ readonly name: string;
+ readonly node_id: string;
+ readonly size: number;
+ /**
+ * @description State of the release asset.
+ * @enum {string}
+ */
+ readonly state: "uploaded";
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** User */
+ readonly uploader?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
/** Format: uri */
- readonly url?: string;
- } | null;
+ readonly url: string;
+ } | null)[];
+ /** Format: uri */
+ readonly assets_url: string;
/** User */
- readonly sponsorable: {
+ readonly author: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -86655,222 +79436,422 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly created_at: string | null;
+ /** Format: uri */
+ readonly discussion_url?: string;
+ /** @description Whether the release is a draft or published */
+ readonly draft: boolean;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string | null;
+ readonly node_id: string;
/**
- * Sponsorship Tier
- * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
+ * @description Whether the release is identified as a prerelease or a full release.
+ * @enum {boolean}
*/
- readonly tier: {
- readonly created_at: string;
- readonly description: string;
- readonly is_custom_ammount?: boolean;
- readonly is_custom_amount?: boolean;
- readonly is_one_time: boolean;
- readonly monthly_price_in_cents: number;
- readonly monthly_price_in_dollars: number;
- readonly name: string;
- readonly node_id: string;
+ readonly prerelease: true;
+ /** Format: date-time */
+ readonly published_at: string | null;
+ /** Reactions */
+ readonly reactions?: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
};
+ /** @description The name of the tag. */
+ readonly tag_name: string;
+ /** Format: uri */
+ readonly tarball_url: string | null;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. */
+ readonly target_commitish: string;
+ /** Format: uri-template */
+ readonly upload_url: string;
+ /** Format: uri */
+ readonly url: string;
+ /** Format: uri */
+ readonly zipball_url: string | null;
};
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
};
- /** sponsorship pending_tier_change event */
- readonly "webhook-sponsorship-pending-tier-change": {
+ /** release published event */
+ readonly "webhook-release-published": {
/** @enum {string} */
- readonly action: "pending_tier_change";
+ readonly action: "published";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly release: components["schemas"]["webhooks_release_1"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** release released event */
+ readonly "webhook-release-released": {
+ /** @enum {string} */
+ readonly action: "released";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly release: components["schemas"]["webhooks_release"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** release unpublished event */
+ readonly "webhook-release-unpublished": {
+ /** @enum {string} */
+ readonly action: "unpublished";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly release: components["schemas"]["webhooks_release_1"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Repository advisory published event */
+ readonly "webhook-repository-advisory-published": {
+ /** @enum {string} */
+ readonly action: "published";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly repository_advisory: components["schemas"]["repository-advisory"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Repository advisory reported event */
+ readonly "webhook-repository-advisory-reported": {
+ /** @enum {string} */
+ readonly action: "reported";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly repository_advisory: components["schemas"]["repository-advisory"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository archived event */
+ readonly "webhook-repository-archived": {
+ /** @enum {string} */
+ readonly action: "archived";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository created event */
+ readonly "webhook-repository-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository deleted event */
+ readonly "webhook-repository-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository_dispatch event */
+ readonly "webhook-repository-dispatch-sample": {
+ /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */
+ readonly action: string;
+ readonly branch: string;
+ /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */
+ readonly client_payload: {
+ readonly [key: string]: unknown;
+ } | null;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository edited event */
+ readonly "webhook-repository-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
readonly changes: {
- readonly tier: {
- /**
- * Sponsorship Tier
- * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
- */
- readonly from: {
- readonly created_at: string;
- readonly description: string;
- readonly is_custom_ammount?: boolean;
- readonly is_custom_amount?: boolean;
- readonly is_one_time: boolean;
- readonly monthly_price_in_cents: number;
- readonly monthly_price_in_dollars: number;
- readonly name: string;
- readonly node_id: string;
+ readonly default_branch?: {
+ readonly from: string;
+ };
+ readonly description?: {
+ readonly from: string | null;
+ };
+ readonly homepage?: {
+ readonly from: string | null;
+ };
+ readonly topics?: {
+ readonly from?: string[] | null;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository_import event */
+ readonly "webhook-repository-import": {
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ /** @enum {string} */
+ readonly status: "success" | "cancelled" | "failure";
+ };
+ /** repository privatized event */
+ readonly "webhook-repository-privatized": {
+ /** @enum {string} */
+ readonly action: "privatized";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository publicized event */
+ readonly "webhook-repository-publicized": {
+ /** @enum {string} */
+ readonly action: "publicized";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository renamed event */
+ readonly "webhook-repository-renamed": {
+ /** @enum {string} */
+ readonly action: "renamed";
+ readonly changes: {
+ readonly repository: {
+ readonly name: {
+ readonly from: string;
};
};
};
- /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */
- readonly effective_date?: string;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository ruleset created event */
+ readonly "webhook-repository-ruleset-created": {
+ /** @enum {string} */
+ readonly action: "created";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository_ruleset: components["schemas"]["repository-ruleset"];
readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly sponsorship: {
- readonly created_at: string;
- readonly maintainer?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
+ };
+ /** repository ruleset deleted event */
+ readonly "webhook-repository-ruleset-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository_ruleset: components["schemas"]["repository-ruleset"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository ruleset edited event */
+ readonly "webhook-repository-ruleset-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository_ruleset: components["schemas"]["repository-ruleset"];
+ readonly changes?: {
+ readonly name?: {
+ readonly from?: string;
};
- readonly node_id: string;
- readonly privacy_level: string;
- /** User */
- readonly sponsor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** User */
- readonly sponsorable: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * Sponsorship Tier
- * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
- */
- readonly tier: {
- readonly created_at: string;
- readonly description: string;
- readonly is_custom_ammount?: boolean;
- readonly is_custom_amount?: boolean;
- readonly is_one_time: boolean;
- readonly monthly_price_in_cents: number;
- readonly monthly_price_in_dollars: number;
- readonly name: string;
- readonly node_id: string;
+ readonly enforcement?: {
+ readonly from?: string;
+ };
+ readonly conditions?: {
+ readonly added?: components["schemas"]["repository-ruleset-conditions"][];
+ readonly deleted?: components["schemas"]["repository-ruleset-conditions"][];
+ readonly updated?: {
+ readonly condition?: components["schemas"]["repository-ruleset-conditions"];
+ readonly changes?: {
+ readonly condition_type?: {
+ readonly from?: string;
+ };
+ readonly target?: {
+ readonly from?: string;
+ };
+ readonly include?: {
+ readonly from?: string[];
+ };
+ readonly exclude?: {
+ readonly from?: string[];
+ };
+ };
+ }[];
+ };
+ readonly rules?: {
+ readonly added?: components["schemas"]["repository-rule"][];
+ readonly deleted?: components["schemas"]["repository-rule"][];
+ readonly updated?: {
+ readonly rule?: components["schemas"]["repository-rule"];
+ readonly changes?: {
+ readonly configuration?: {
+ readonly from?: string;
+ };
+ readonly rule_type?: {
+ readonly from?: string;
+ };
+ readonly pattern?: {
+ readonly from?: string;
+ };
+ };
+ }[];
+ };
+ };
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository transferred event */
+ readonly "webhook-repository-transferred": {
+ /** @enum {string} */
+ readonly action: "transferred";
+ readonly changes: {
+ readonly owner: {
+ readonly from: {
+ /** Organization */
+ readonly organization?: {
+ /** Format: uri */
+ readonly avatar_url: string;
+ readonly description: string | null;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly hooks_url: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly issues_url: string;
+ readonly login: string;
+ /** Format: uri-template */
+ readonly members_url: string;
+ readonly node_id: string;
+ /** Format: uri-template */
+ readonly public_members_url: string;
+ /** Format: uri */
+ readonly repos_url: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** User */
+ readonly user?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
};
};
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** sponsorship tier_changed event */
- readonly "webhook-sponsorship-tier-changed": {
+ /** repository unarchived event */
+ readonly "webhook-repository-unarchived": {
/** @enum {string} */
- readonly action: "tier_changed";
- readonly changes: {
- readonly tier: {
- /**
- * Sponsorship Tier
- * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
- */
- readonly from: {
- readonly created_at: string;
- readonly description: string;
- readonly is_custom_ammount?: boolean;
- readonly is_custom_amount?: boolean;
- readonly is_one_time: boolean;
- readonly monthly_price_in_cents: number;
- readonly monthly_price_in_dollars: number;
- readonly name: string;
- readonly node_id: string;
- };
- };
- };
+ readonly action: "unarchived";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository_vulnerability_alert create event */
+ readonly "webhook-repository-vulnerability-alert-create": {
+ /** @enum {string} */
+ readonly action: "create";
+ readonly alert: components["schemas"]["webhooks_alert"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly sponsorship: {
+ };
+ /** repository_vulnerability_alert dismiss event */
+ readonly "webhook-repository-vulnerability-alert-dismiss": {
+ /** @enum {string} */
+ readonly action: "dismiss";
+ /**
+ * Repository Vulnerability Alert Alert
+ * @description The security alert of the vulnerable dependency.
+ */
+ readonly alert: {
+ readonly affected_package_name: string;
+ readonly affected_range: string;
readonly created_at: string;
- readonly maintainer?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly node_id: string;
- readonly privacy_level: string;
+ readonly dismiss_comment?: string | null;
+ readonly dismiss_reason: string;
+ readonly dismissed_at: string;
/** User */
- readonly sponsor: {
+ readonly dismisser: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -86906,8 +79887,54 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
+ readonly external_identifier: string;
+ /** Format: uri */
+ readonly external_reference: string | null;
+ readonly fix_reason?: string;
+ /** Format: date-time */
+ readonly fixed_at?: string;
+ readonly fixed_in?: string;
+ readonly ghsa_id: string;
+ readonly id: number;
+ readonly node_id: string;
+ readonly number: number;
+ readonly severity: string;
+ /** @enum {string} */
+ readonly state: "dismissed";
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository_vulnerability_alert reopen event */
+ readonly "webhook-repository-vulnerability-alert-reopen": {
+ /** @enum {string} */
+ readonly action: "reopen";
+ readonly alert: components["schemas"]["webhooks_alert"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository_vulnerability_alert resolve event */
+ readonly "webhook-repository-vulnerability-alert-resolve": {
+ /** @enum {string} */
+ readonly action: "resolve";
+ /**
+ * Repository Vulnerability Alert Alert
+ * @description The security alert of the vulnerable dependency.
+ */
+ readonly alert: {
+ readonly affected_package_name: string;
+ readonly affected_range: string;
+ readonly created_at: string;
+ readonly dismiss_reason?: string;
+ readonly dismissed_at?: string;
/** User */
- readonly sponsorable: {
+ readonly dismisser?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -86943,22 +79970,255 @@ export type components = {
/** Format: uri */
readonly url?: string;
} | null;
- /**
- * Sponsorship Tier
- * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
- */
- readonly tier: {
- readonly created_at: string;
- readonly description: string;
- readonly is_custom_ammount?: boolean;
- readonly is_custom_amount?: boolean;
- readonly is_one_time: boolean;
- readonly monthly_price_in_cents: number;
- readonly monthly_price_in_dollars: number;
+ readonly external_identifier: string;
+ /** Format: uri */
+ readonly external_reference: string | null;
+ readonly fix_reason?: string;
+ /** Format: date-time */
+ readonly fixed_at?: string;
+ readonly fixed_in?: string;
+ readonly ghsa_id: string;
+ readonly id: number;
+ readonly node_id: string;
+ readonly number: number;
+ readonly severity: string;
+ /** @enum {string} */
+ readonly state: "fixed" | "open";
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** secret_scanning_alert created event */
+ readonly "webhook-secret-scanning-alert-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Secret Scanning Alert Location Created Event */
+ readonly "webhook-secret-scanning-alert-location-created": {
+ /** @enum {string} */
+ readonly action?: "created";
+ readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly location: components["schemas"]["secret-scanning-location"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Secret Scanning Alert Location Created Event */
+ readonly "webhook-secret-scanning-alert-location-created-form-encoded": {
+ /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */
+ readonly payload: string;
+ };
+ /** secret_scanning_alert reopened event */
+ readonly "webhook-secret-scanning-alert-reopened": {
+ /** @enum {string} */
+ readonly action: "reopened";
+ readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** secret_scanning_alert resolved event */
+ readonly "webhook-secret-scanning-alert-resolved": {
+ /** @enum {string} */
+ readonly action: "resolved";
+ readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** secret_scanning_alert revoked event */
+ readonly "webhook-secret-scanning-alert-revoked": {
+ /** @enum {string} */
+ readonly action: "revoked";
+ readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** secret_scanning_alert validated event */
+ readonly "webhook-secret-scanning-alert-validated": {
+ /** @enum {string} */
+ readonly action: "validated";
+ readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** security_advisory published event */
+ readonly "webhook-security-advisory-published": {
+ /** @enum {string} */
+ readonly action: "published";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly security_advisory: components["schemas"]["webhooks_security_advisory"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** security_advisory updated event */
+ readonly "webhook-security-advisory-updated": {
+ /** @enum {string} */
+ readonly action: "updated";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly security_advisory: components["schemas"]["webhooks_security_advisory"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** security_advisory withdrawn event */
+ readonly "webhook-security-advisory-withdrawn": {
+ /** @enum {string} */
+ readonly action: "withdrawn";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ /** @description The details of the security advisory, including summary, description, and severity. */
+ readonly security_advisory: {
+ readonly cvss: {
+ readonly score: number;
+ readonly vector_string: string | null;
+ };
+ readonly cwes: {
+ readonly cwe_id: string;
readonly name: string;
- readonly node_id: string;
+ }[];
+ readonly description: string;
+ readonly ghsa_id: string;
+ readonly identifiers: {
+ readonly type: string;
+ readonly value: string;
+ }[];
+ readonly published_at: string;
+ readonly references: {
+ /** Format: uri */
+ readonly url: string;
+ }[];
+ readonly severity: string;
+ readonly summary: string;
+ readonly updated_at: string;
+ readonly vulnerabilities: {
+ readonly first_patched_version: {
+ readonly identifier: string;
+ } | null;
+ readonly package: {
+ readonly ecosystem: string;
+ readonly name: string;
+ };
+ readonly severity: string;
+ readonly vulnerable_version_range: string;
+ }[];
+ readonly withdrawn_at: string;
+ };
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** security_and_analysis event */
+ readonly "webhook-security-and-analysis": {
+ readonly changes: {
+ readonly from?: {
+ readonly security_and_analysis?: components["schemas"]["security-and-analysis"];
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["full-repository"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** sponsorship cancelled event */
+ readonly "webhook-sponsorship-cancelled": {
+ /** @enum {string} */
+ readonly action: "cancelled";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly sponsorship: components["schemas"]["webhooks_sponsorship"];
+ };
+ /** sponsorship created event */
+ readonly "webhook-sponsorship-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly sponsorship: components["schemas"]["webhooks_sponsorship"];
+ };
+ /** sponsorship edited event */
+ readonly "webhook-sponsorship-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ readonly changes: {
+ readonly privacy_level?: {
+ /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */
+ readonly from: string;
};
};
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly sponsorship: components["schemas"]["webhooks_sponsorship"];
+ };
+ /** sponsorship pending_cancellation event */
+ readonly "webhook-sponsorship-pending-cancellation": {
+ /** @enum {string} */
+ readonly action: "pending_cancellation";
+ readonly effective_date?: components["schemas"]["webhooks_effective_date"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly sponsorship: components["schemas"]["webhooks_sponsorship"];
+ };
+ /** sponsorship pending_tier_change event */
+ readonly "webhook-sponsorship-pending-tier-change": {
+ /** @enum {string} */
+ readonly action: "pending_tier_change";
+ readonly changes: components["schemas"]["webhooks_changes_8"];
+ readonly effective_date?: components["schemas"]["webhooks_effective_date"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly sponsorship: components["schemas"]["webhooks_sponsorship"];
+ };
+ /** sponsorship tier_changed event */
+ readonly "webhook-sponsorship-tier-changed": {
+ /** @enum {string} */
+ readonly action: "tier_changed";
+ readonly changes: components["schemas"]["webhooks_changes_8"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly sponsorship: components["schemas"]["webhooks_sponsorship"];
};
/** star created event */
readonly "webhook-star-created": {
@@ -87163,71 +80423,7 @@ export type components = {
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
- /**
- * Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly team: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- };
+ readonly team: components["schemas"]["webhooks_team_1"];
};
/** team added_to_repository event */
readonly "webhook-team-added-to-repository": {
@@ -87476,71 +80672,7 @@ export type components = {
readonly watchers_count: number;
};
readonly sender?: components["schemas"]["simple-user-webhooks"];
- /**
- * Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly team: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- };
+ readonly team: components["schemas"]["webhooks_team_1"];
};
/** team created event */
readonly "webhook-team-created": {
@@ -87789,71 +80921,7 @@ export type components = {
readonly watchers_count: number;
};
readonly sender: components["schemas"]["simple-user-webhooks"];
- /**
- * Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly team: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- };
+ readonly team: components["schemas"]["webhooks_team_1"];
};
/** team deleted event */
readonly "webhook-team-deleted": {
@@ -88102,71 +81170,7 @@ export type components = {
readonly watchers_count: number;
};
readonly sender?: components["schemas"]["simple-user-webhooks"];
- /**
- * Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly team: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- };
+ readonly team: components["schemas"]["webhooks_team_1"];
};
/** team edited event */
readonly "webhook-team-edited": {
@@ -88446,71 +81450,7 @@ export type components = {
readonly watchers_count: number;
};
readonly sender: components["schemas"]["simple-user-webhooks"];
- /**
- * Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly team: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- };
+ readonly team: components["schemas"]["webhooks_team_1"];
};
/** team removed_from_repository event */
readonly "webhook-team-removed-from-repository": {
@@ -88759,71 +81699,7 @@ export type components = {
readonly watchers_count: number;
};
readonly sender: components["schemas"]["simple-user-webhooks"];
- /**
- * Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly team: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- };
+ readonly team: components["schemas"]["webhooks_team_1"];
};
/** watch started event */
readonly "webhook-watch-started": {
@@ -89069,66 +81945,12 @@ export type components = {
readonly runner_name: string | null;
/** Format: date-time */
readonly started_at: string;
- /** @enum {string} */
- readonly status: "queued" | "in_progress" | "completed" | "waiting";
- /** @description The name of the current branch. */
- readonly head_branch: string | null;
- /** @description The name of the workflow. */
- readonly workflow_name: string | null;
- readonly steps: {
- readonly completed_at: string | null;
- /** @enum {string|null} */
- readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null;
- readonly name: string;
- readonly number: number;
- readonly started_at: string | null;
- /** @enum {string} */
- readonly status: "completed" | "in_progress" | "queued" | "pending";
- }[];
- /** Format: uri */
- readonly url: string;
- };
- readonly deployment?: components["schemas"]["deployment"];
- };
- /** workflow_job waiting event */
- readonly "webhook-workflow-job-waiting": {
- /** @enum {string} */
- readonly action: "waiting";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly workflow_job: {
- /** Format: uri */
- readonly check_run_url: string;
- readonly completed_at: string | null;
- readonly conclusion: string | null;
- /** @description The time that the job created. */
- readonly created_at: string;
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly labels: string[];
- readonly name: string;
- readonly node_id: string;
- readonly run_attempt: number;
- readonly run_id: number;
- /** Format: uri */
- readonly run_url: string;
- readonly runner_group_id: number | null;
- readonly runner_group_name: string | null;
- readonly runner_id: number | null;
- readonly runner_name: string | null;
- /** Format: date-time */
- readonly started_at: string;
+ /** @enum {string} */
+ readonly status: "queued" | "in_progress" | "completed" | "waiting";
/** @description The name of the current branch. */
readonly head_branch: string | null;
/** @description The name of the workflow. */
readonly workflow_name: string | null;
- /** @enum {string} */
- readonly status: "queued" | "in_progress" | "completed" | "waiting";
readonly steps: {
readonly completed_at: string | null;
/** @enum {string|null} */
@@ -89137,40 +81959,78 @@ export type components = {
readonly number: number;
readonly started_at: string | null;
/** @enum {string} */
- readonly status: "completed" | "in_progress" | "queued" | "pending" | "waiting";
+ readonly status: "completed" | "in_progress" | "queued" | "pending";
}[];
/** Format: uri */
readonly url: string;
};
readonly deployment?: components["schemas"]["deployment"];
};
- /** workflow_run completed event */
- readonly "webhook-workflow-run-completed": {
+ /** workflow_job waiting event */
+ readonly "webhook-workflow-job-waiting": {
/** @enum {string} */
- readonly action: "completed";
+ readonly action: "waiting";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
- /** Workflow */
- readonly workflow: {
+ readonly workflow_job: {
/** Format: uri */
- readonly badge_url: string;
- /** Format: date-time */
+ readonly check_run_url: string;
+ readonly completed_at: string | null;
+ readonly conclusion: string | null;
+ /** @description The time that the job created. */
readonly created_at: string;
+ readonly head_sha: string;
/** Format: uri */
readonly html_url: string;
readonly id: number;
+ readonly labels: string[];
readonly name: string;
readonly node_id: string;
- readonly path: string;
- readonly state: string;
+ readonly run_attempt: number;
+ readonly run_id: number;
+ /** Format: uri */
+ readonly run_url: string;
+ readonly runner_group_id: number | null;
+ readonly runner_group_name: string | null;
+ readonly runner_id: number | null;
+ readonly runner_name: string | null;
/** Format: date-time */
- readonly updated_at: string;
+ readonly started_at: string;
+ /** @description The name of the current branch. */
+ readonly head_branch: string | null;
+ /** @description The name of the workflow. */
+ readonly workflow_name: string | null;
+ /** @enum {string} */
+ readonly status: "queued" | "in_progress" | "completed" | "waiting";
+ readonly steps: {
+ readonly completed_at: string | null;
+ /** @enum {string|null} */
+ readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null;
+ readonly name: string;
+ readonly number: number;
+ readonly started_at: string | null;
+ /** @enum {string} */
+ readonly status: "completed" | "in_progress" | "queued" | "pending" | "waiting";
+ }[];
/** Format: uri */
readonly url: string;
- } | null;
+ };
+ readonly deployment?: components["schemas"]["deployment"];
+ };
+ /** workflow_run completed event */
+ readonly "webhook-workflow-run-completed": {
+ /** @enum {string} */
+ readonly action: "completed";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly workflow: components["schemas"]["webhooks_workflow"];
+ /** Workflow Run */
readonly workflow_run: {
/** User */
readonly actor: {
@@ -89218,7 +82078,7 @@ export type components = {
/** Format: uri */
readonly check_suite_url: string;
/** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped";
+ readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out";
/** Format: date-time */
readonly created_at: string;
readonly event: string;
@@ -89395,7 +82255,7 @@ export type components = {
readonly path: string;
/** Format: uri */
readonly previous_attempt_url: string | null;
- readonly pull_requests: {
+ readonly pull_requests: ({
readonly base: {
readonly ref: string;
/** Repo Ref */
@@ -89422,7 +82282,7 @@ export type components = {
readonly number: number;
/** Format: uri */
readonly url: string;
- }[];
+ } | null)[];
readonly referenced_workflows?: {
readonly path: string;
readonly ref?: string;
@@ -89606,229 +82466,11 @@ export type components = {
readonly workflow_id: number;
/** Format: uri */
readonly workflow_url: string;
- } & {
- readonly actor?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id?: number;
- readonly check_suite_node_id?: string;
- readonly check_suite_url?: string;
- /** @enum {string} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped";
- readonly created_at?: string;
- readonly event?: string;
- readonly head_branch?: string | null;
- readonly head_commit?: {
- readonly author?: {
- readonly email?: string;
- readonly name?: string;
- };
- readonly committer?: {
- readonly email?: string;
- readonly name?: string;
- };
- readonly id?: string;
- readonly message?: string;
- readonly timestamp?: string;
- readonly tree_id?: string;
- };
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name?: string | null;
- readonly node_id?: string;
- readonly path?: string;
- readonly previous_attempt_url?: string | null;
- readonly pull_requests?: Record[];
- readonly referenced_workflows?: {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
- }[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt?: number;
- readonly run_number?: number;
- readonly run_started_at?: string;
- readonly status?: string;
- readonly triggering_actor?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- } | null;
- readonly updated_at?: string;
- readonly url?: string;
- readonly workflow_id?: number;
- readonly workflow_url?: string;
+ /**
+ * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow.
+ * @example Simple Workflow
+ */
+ readonly display_title?: string;
};
};
/** workflow_run in_progress event */
@@ -89840,24 +82482,8 @@ export type components = {
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
- /** Workflow */
- readonly workflow: {
- /** Format: uri */
- readonly badge_url: string;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly state: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
+ readonly workflow: components["schemas"]["webhooks_workflow"];
+ /** Workflow Run */
readonly workflow_run: {
/** User */
readonly actor: {
@@ -89905,7 +82531,7 @@ export type components = {
/** Format: uri */
readonly check_suite_url: string;
/** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null;
+ readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out";
/** Format: date-time */
readonly created_at: string;
readonly event: string;
@@ -90005,7 +82631,7 @@ export type components = {
/** Format: uri-template */
readonly milestones_url: string;
/** @description The name of the repository. */
- readonly name: string;
+ readonly name: string | null;
readonly node_id: string;
/** Format: uri-template */
readonly notifications_url: string;
@@ -90082,7 +82708,7 @@ export type components = {
readonly path: string;
/** Format: uri */
readonly previous_attempt_url: string | null;
- readonly pull_requests: {
+ readonly pull_requests: ({
readonly base: {
readonly ref: string;
/** Repo Ref */
@@ -90109,7 +82735,7 @@ export type components = {
readonly number: number;
/** Format: uri */
readonly url: string;
- }[];
+ } | null)[];
readonly referenced_workflows?: {
readonly path: string;
readonly ref?: string;
@@ -90293,229 +82919,6 @@ export type components = {
readonly workflow_id: number;
/** Format: uri */
readonly workflow_url: string;
- } & {
- readonly actor?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id?: number;
- readonly check_suite_node_id?: string;
- readonly check_suite_url?: string;
- /** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "skipped" | "stale";
- readonly created_at?: string;
- readonly event?: string;
- readonly head_branch?: string | null;
- readonly head_commit?: {
- readonly author?: {
- readonly email?: string;
- readonly name?: string;
- };
- readonly committer?: {
- readonly email?: string;
- readonly name?: string;
- };
- readonly id?: string;
- readonly message?: string;
- readonly timestamp?: string;
- readonly tree_id?: string;
- };
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string | null;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name?: string | null;
- readonly node_id?: string;
- readonly path?: string;
- readonly previous_attempt_url?: string | null;
- readonly pull_requests?: Record[];
- readonly referenced_workflows?: {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
- }[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt?: number;
- readonly run_number?: number;
- readonly run_started_at?: string;
- readonly status?: string;
- readonly triggering_actor?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly updated_at?: string;
- readonly url?: string;
- readonly workflow_id?: number;
- readonly workflow_url?: string;
};
};
/** workflow_run requested event */
@@ -90527,24 +82930,7 @@ export type components = {
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
- /** Workflow */
- readonly workflow: {
- /** Format: uri */
- readonly badge_url: string;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly state: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
+ readonly workflow: components["schemas"]["webhooks_workflow"];
/** Workflow Run */
readonly workflow_run: {
/** User */
@@ -91057,6 +83443,15 @@ export type components = {
readonly "application/json": components["schemas"]["basic-error"];
};
};
+ /** @description Internal Error */
+ readonly internal_error: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["basic-error"];
+ };
+ };
/** @description Service unavailable */
readonly service_unavailable: {
headers: {
@@ -91142,15 +83537,6 @@ export type components = {
};
};
};
- /** @description Internal Error */
- readonly internal_error: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["basic-error"];
- };
- };
/** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */
readonly package_es_list_error: {
headers: {
@@ -91235,22 +83621,31 @@ export type components = {
readonly "application/json": components["schemas"]["basic-error"];
};
};
+ /** @description Unacceptable */
+ readonly unacceptable: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["basic-error"];
+ };
+ };
};
parameters: {
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly "pagination-before": string;
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly "pagination-after": string;
/** @description The direction to sort the results by. */
readonly direction: "asc" | "desc";
/** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */
readonly ghsa_id: string;
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly "per-page": number;
/** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */
readonly cursor: string;
readonly "delivery-id": number;
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page: number;
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since: string;
@@ -91341,7 +83736,7 @@ export type components = {
readonly "runner-label-name": string;
/** @description The name of the secret. */
readonly "secret-name": string;
- /** @description The number of results per page (max 30). */
+ /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly "variables-per-page": number;
/** @description The name of the variable. */
readonly "variable-name": string;
@@ -91452,7 +83847,7 @@ export type components = {
readonly "workflow-run-branch": string;
/** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */
readonly event: string;
- /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */
+ /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */
readonly "workflow-run-status": "completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending";
/** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */
readonly created: string;
@@ -91499,12 +83894,17 @@ export type components = {
readonly "manifest-path": string;
/** @description deployment_id parameter */
readonly "deployment-id": number;
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly "environment-name": string;
/** @description The unique identifier of the branch policy. */
readonly "branch-policy-id": number;
/** @description The unique identifier of the protection rule. */
readonly "protection-rule-id": number;
+ /**
+ * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
+ * @example heads/feature-a
+ */
+ readonly "git-ref-only": string;
/** @description A user ID. Only return users with an ID greater than this ID. */
readonly "since-user": number;
/** @description The number that identifies the issue. */
@@ -91513,6 +83913,8 @@ export type components = {
readonly "key-id": number;
/** @description The number that identifies the milestone. */
readonly "milestone-number": number;
+ /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */
+ readonly "pages-deployment-id": number | string;
/** @description The number that identifies the pull request. */
readonly "pull-number": number;
/** @description The unique identifier of the review. */
@@ -91599,7 +84001,7 @@ export interface operations {
/** @description If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. */
readonly cve_id?: string;
/** @description If specified, only advisories for these ecosystems will be returned. */
- readonly ecosystem?: "actions" | "composer" | "erlang" | "go" | "maven" | "npm" | "nuget" | "other" | "pip" | "pub" | "rubygems" | "rust";
+ readonly ecosystem?: components["schemas"]["security-advisory-ecosystems"];
/** @description If specified, only advisories with these severities will be returned. */
readonly severity?: "unknown" | "low" | "medium" | "high" | "critical";
/** @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.
@@ -91625,13 +84027,13 @@ export interface operations {
*
* For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */
readonly modified?: string;
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly before?: components["parameters"]["pagination-before"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly after?: components["parameters"]["pagination-after"];
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: number;
/** @description The property to sort the results by. */
readonly sort?: "updated" | "published";
@@ -91789,7 +84191,7 @@ export interface operations {
readonly "apps/list-webhook-deliveries": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
/** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */
readonly cursor?: components["parameters"]["cursor"];
@@ -91857,9 +84259,9 @@ export interface operations {
readonly "apps/list-installation-requests-for-authenticated-app": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -91884,9 +84286,9 @@ export interface operations {
readonly "apps/list-installations": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since?: components["parameters"]["since"];
@@ -92271,9 +84673,9 @@ export interface operations {
readonly "classroom/list-accepted-assigments-for-an-assignment": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -92323,9 +84725,9 @@ export interface operations {
readonly "classroom/list-classrooms": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -92372,9 +84774,9 @@ export interface operations {
readonly "classroom/list-assignments-for-a-classroom": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -92465,6 +84867,42 @@ export interface operations {
readonly 304: components["responses"]["not_modified"];
};
};
+ readonly "copilot/usage-metrics-for-enterprise": {
+ readonly parameters: {
+ readonly query?: {
+ /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */
+ readonly since?: string;
+ /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */
+ readonly until?: string;
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ readonly page?: components["parameters"]["page"];
+ /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ readonly per_page?: number;
+ };
+ readonly header?: never;
+ readonly path: {
+ /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
+ readonly enterprise: components["parameters"]["enterprise"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["copilot-usage-metrics"][];
+ };
+ };
+ readonly 401: components["responses"]["requires_authentication"];
+ readonly 403: components["responses"]["forbidden"];
+ readonly 404: components["responses"]["not_found"];
+ readonly 500: components["responses"]["internal_error"];
+ };
+ };
readonly "dependabot/list-alerts-for-enterprise": {
readonly parameters: {
readonly query?: {
@@ -92490,9 +84928,9 @@ export interface operations {
readonly sort?: components["parameters"]["dependabot-alert-sort"];
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly before?: components["parameters"]["pagination-before"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly after?: components["parameters"]["pagination-after"];
/** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result.
* This parameter must not be used in combination with `last`.
@@ -92502,7 +84940,7 @@ export interface operations {
* This parameter must not be used in combination with `first`.
* Instead, use `per_page` in combination with `before` to fetch the last page of results. */
readonly last?: components["parameters"]["pagination-last"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -92544,11 +84982,11 @@ export interface operations {
readonly sort?: components["parameters"]["secret-scanning-alert-sort"];
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly before?: components["parameters"]["pagination-before"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly after?: components["parameters"]["pagination-after"];
/** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */
readonly validity?: components["parameters"]["secret-scanning-alert-validity"];
@@ -92579,9 +85017,9 @@ export interface operations {
readonly "activity/list-public-events": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -92629,9 +85067,9 @@ export interface operations {
readonly query?: {
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since?: components["parameters"]["since"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -92710,9 +85148,9 @@ export interface operations {
readonly query?: {
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since?: components["parameters"]["since"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -92741,9 +85179,9 @@ export interface operations {
readonly query?: {
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since?: components["parameters"]["since"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -92876,9 +85314,9 @@ export interface operations {
readonly "gists/list-comments": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -93036,9 +85474,9 @@ export interface operations {
readonly "gists/list-commits": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -93069,9 +85507,9 @@ export interface operations {
readonly "gists/list-forks": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -93281,9 +85719,9 @@ export interface operations {
readonly "apps/list-repos-accessible-to-installation": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -93349,9 +85787,9 @@ export interface operations {
readonly orgs?: boolean;
readonly owned?: boolean;
readonly pulls?: boolean;
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -93379,9 +85817,9 @@ export interface operations {
readonly parameters: {
readonly query?: {
readonly featured?: boolean;
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -93531,9 +85969,9 @@ export interface operations {
readonly "apps/list-plans": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -93563,9 +86001,9 @@ export interface operations {
readonly sort?: components["parameters"]["sort"];
/** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */
readonly direction?: "asc" | "desc";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -93626,9 +86064,9 @@ export interface operations {
readonly "apps/list-plans-stubbed": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -93657,9 +86095,9 @@ export interface operations {
readonly sort?: components["parameters"]["sort"];
/** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */
readonly direction?: "asc" | "desc";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -93708,9 +86146,9 @@ export interface operations {
readonly "activity/list-public-events-for-repo-network": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -93750,9 +86188,9 @@ export interface operations {
readonly since?: components["parameters"]["since"];
/** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly before?: components["parameters"]["before"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 50). */
+ /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: number;
};
readonly header?: never;
@@ -93847,6 +86285,27 @@ export interface operations {
readonly 403: components["responses"]["forbidden"];
};
};
+ readonly "activity/mark-thread-as-done": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */
+ readonly thread_id: components["parameters"]["thread-id"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description No content */
+ readonly 204: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
readonly "activity/mark-thread-as-read": {
readonly parameters: {
readonly query?: never;
@@ -93984,7 +86443,7 @@ export interface operations {
readonly query?: {
/** @description An organization ID. Only return organizations with an ID greater than this ID. */
readonly since?: components["parameters"]["since-org"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -94073,7 +86532,7 @@ export interface operations {
readonly location?: string;
/** @description The shorthand name of the company. */
readonly name?: string;
- /** @description The description of the company. */
+ /** @description The description of the company. The maximum size is 160 characters. */
readonly description?: string;
/** @description Whether an organization can use organization projects. */
readonly has_organization_projects?: boolean;
@@ -94221,9 +86680,9 @@ export interface operations {
readonly "actions/get-actions-cache-usage-by-repo-for-org": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -94356,9 +86815,9 @@ export interface operations {
readonly "actions/list-selected-repositories-enabled-github-actions-organization": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -94559,9 +87018,9 @@ export interface operations {
readonly query?: {
/** @description The name of a self-hosted runner. */
readonly name?: string;
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -94850,9 +87309,9 @@ export interface operations {
readonly "actions/list-org-secrets": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -95001,9 +87460,9 @@ export interface operations {
readonly "actions/list-selected-repos-for-org-secret": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -95126,9 +87585,9 @@ export interface operations {
readonly "actions/list-org-variables": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 30). */
+ /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["variables-per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -95284,9 +87743,9 @@ export interface operations {
readonly "actions/list-selected-repos-for-org-variable": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -95423,9 +87882,9 @@ export interface operations {
readonly "orgs/list-blocked-users": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -95534,13 +87993,13 @@ export interface operations {
readonly tool_name?: components["parameters"]["tool-name"];
/** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
readonly tool_guid?: components["parameters"]["tool-guid"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly before?: components["parameters"]["pagination-before"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly after?: components["parameters"]["pagination-after"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
@@ -95577,9 +88036,9 @@ export interface operations {
readonly "codespaces/list-in-organization": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -95735,9 +88194,9 @@ export interface operations {
readonly "codespaces/list-org-secrets": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -95890,9 +88349,9 @@ export interface operations {
readonly "codespaces/list-selected-repos-for-org-secret": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -96049,15 +88508,22 @@ export interface operations {
readonly 401: components["responses"]["requires_authentication"];
readonly 403: components["responses"]["forbidden"];
readonly 404: components["responses"]["not_found"];
+ /** @description There is a problem with your account's associated payment method. */
+ readonly 422: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content?: never;
+ };
readonly 500: components["responses"]["internal_error"];
};
};
readonly "copilot/list-copilot-seats": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: number;
};
readonly header?: never;
@@ -96077,7 +88543,7 @@ export interface operations {
};
content: {
readonly "application/json": {
- /** @description Total number of Copilot For Business seats for the organization currently being billed. */
+ /** @description Total number of Copilot seats for the organization currently being billed. */
readonly total_seats?: number;
readonly seats?: components["schemas"]["copilot-seat-details"][];
};
@@ -96089,7 +88555,7 @@ export interface operations {
readonly 500: components["responses"]["internal_error"];
};
};
- readonly "copilot/add-copilot-for-business-seats-for-teams": {
+ readonly "copilot/add-copilot-seats-for-teams": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
@@ -96122,7 +88588,7 @@ export interface operations {
readonly 401: components["responses"]["requires_authentication"];
readonly 403: components["responses"]["forbidden"];
readonly 404: components["responses"]["not_found"];
- /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */
+ /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */
readonly 422: {
headers: {
readonly [name: string]: unknown;
@@ -96165,7 +88631,7 @@ export interface operations {
readonly 401: components["responses"]["requires_authentication"];
readonly 403: components["responses"]["forbidden"];
readonly 404: components["responses"]["not_found"];
- /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */
+ /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */
readonly 422: {
headers: {
readonly [name: string]: unknown;
@@ -96175,7 +88641,7 @@ export interface operations {
readonly 500: components["responses"]["internal_error"];
};
};
- readonly "copilot/add-copilot-for-business-seats-for-users": {
+ readonly "copilot/add-copilot-seats-for-users": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
@@ -96208,7 +88674,7 @@ export interface operations {
readonly 401: components["responses"]["requires_authentication"];
readonly 403: components["responses"]["forbidden"];
readonly 404: components["responses"]["not_found"];
- /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */
+ /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */
readonly 422: {
headers: {
readonly [name: string]: unknown;
@@ -96251,7 +88717,7 @@ export interface operations {
readonly 401: components["responses"]["requires_authentication"];
readonly 403: components["responses"]["forbidden"];
readonly 404: components["responses"]["not_found"];
- /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */
+ /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */
readonly 422: {
headers: {
readonly [name: string]: unknown;
@@ -96261,6 +88727,42 @@ export interface operations {
readonly 500: components["responses"]["internal_error"];
};
};
+ readonly "copilot/usage-metrics-for-org": {
+ readonly parameters: {
+ readonly query?: {
+ /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */
+ readonly since?: string;
+ /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */
+ readonly until?: string;
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ readonly page?: components["parameters"]["page"];
+ /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ readonly per_page?: number;
+ };
+ readonly header?: never;
+ readonly path: {
+ /** @description The organization name. The name is not case sensitive. */
+ readonly org: components["parameters"]["org"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["copilot-usage-metrics"][];
+ };
+ };
+ readonly 401: components["responses"]["requires_authentication"];
+ readonly 403: components["responses"]["forbidden"];
+ readonly 404: components["responses"]["not_found"];
+ readonly 500: components["responses"]["internal_error"];
+ };
+ };
readonly "dependabot/list-alerts-for-org": {
readonly parameters: {
readonly query?: {
@@ -96286,9 +88788,9 @@ export interface operations {
readonly sort?: components["parameters"]["dependabot-alert-sort"];
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly before?: components["parameters"]["pagination-before"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly after?: components["parameters"]["pagination-after"];
/** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result.
* This parameter must not be used in combination with `last`.
@@ -96298,7 +88800,7 @@ export interface operations {
* This parameter must not be used in combination with `first`.
* Instead, use `per_page` in combination with `before` to fetch the last page of results. */
readonly last?: components["parameters"]["pagination-last"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -96329,9 +88831,9 @@ export interface operations {
readonly "dependabot/list-org-secrets": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -96480,9 +88982,9 @@ export interface operations {
readonly "dependabot/list-selected-repos-for-org-secret": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -96630,9 +89132,9 @@ export interface operations {
readonly "activity/list-public-org-events": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -96658,9 +89160,9 @@ export interface operations {
readonly "orgs/list-failed-invitations": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -96688,9 +89190,9 @@ export interface operations {
readonly "orgs/list-webhooks": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -96937,7 +89439,7 @@ export interface operations {
readonly "orgs/list-webhook-deliveries": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
/** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */
readonly cursor?: components["parameters"]["cursor"];
@@ -97065,9 +89567,9 @@ export interface operations {
readonly "orgs/list-app-installations": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -97169,9 +89671,9 @@ export interface operations {
readonly "orgs/list-pending-invitations": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description Filter invitations by their member role. */
readonly role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager";
@@ -97222,10 +89724,11 @@ export interface operations {
* * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.
* * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation.
* * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.
+ * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization.
* @default direct_member
* @enum {string}
*/
- readonly role: "admin" | "direct_member" | "billing_manager";
+ readonly role: "admin" | "direct_member" | "billing_manager" | "reinstate";
/** @description Specify IDs for the teams you want to invite new members to. */
readonly team_ids?: number[];
};
@@ -97273,9 +89776,9 @@ export interface operations {
readonly "orgs/list-invitation-teams": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -97317,9 +89820,9 @@ export interface operations {
readonly direction?: components["parameters"]["direction"];
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since?: components["parameters"]["since"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -97351,9 +89854,9 @@ export interface operations {
readonly filter?: "2fa_disabled" | "all";
/** @description Filter members returned by their role. */
readonly role?: "all" | "admin" | "member";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -97444,9 +89947,9 @@ export interface operations {
readonly "codespaces/get-codespaces-for-user-in-org": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -97561,7 +90064,7 @@ export interface operations {
readonly 401: components["responses"]["requires_authentication"];
readonly 403: components["responses"]["forbidden"];
readonly 404: components["responses"]["not_found"];
- /** @description Copilot Business is not enabled for this organization or the user has a pending organization invitation. */
+ /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */
readonly 422: {
headers: {
readonly [name: string]: unknown;
@@ -97666,9 +90169,9 @@ export interface operations {
readonly "migrations/list-for-org": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description Exclude attributes from the API response to improve performance */
readonly exclude?: "repositories"[];
@@ -97877,9 +90380,9 @@ export interface operations {
readonly "migrations/list-repos-for-org": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -98264,9 +90767,9 @@ export interface operations {
readonly "orgs/list-org-role-teams": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -98309,9 +90812,9 @@ export interface operations {
readonly "orgs/list-org-role-users": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -98356,9 +90859,9 @@ export interface operations {
readonly query?: {
/** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */
readonly filter?: "2fa_disabled" | "all";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -98477,9 +90980,9 @@ export interface operations {
* The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.
* For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */
readonly visibility?: components["parameters"]["package-visibility"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: number;
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: number;
};
readonly header?: never;
@@ -98594,9 +91097,9 @@ export interface operations {
readonly "packages/get-all-package-versions-for-package-owned-by-org": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
/** @description The state of the package, either active or deleted. */
readonly state?: "active" | "deleted";
@@ -98720,9 +91223,9 @@ export interface operations {
readonly "orgs/list-pat-grant-requests": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description The property by which to sort the results. */
readonly sort?: components["parameters"]["personal-access-token-sort"];
@@ -98833,9 +91336,9 @@ export interface operations {
readonly "orgs/list-pat-grant-request-repositories": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -98867,9 +91370,9 @@ export interface operations {
readonly "orgs/list-pat-grants": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description The property by which to sort the results. */
readonly sort?: components["parameters"]["personal-access-token-sort"];
@@ -98976,9 +91479,9 @@ export interface operations {
readonly "orgs/list-pat-grant-repositories": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -99012,9 +91515,9 @@ export interface operations {
readonly query?: {
/** @description Indicates the state of the projects to return. */
readonly state?: "open" | "closed" | "all";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -99184,10 +91687,11 @@ export interface operations {
/** @description Whether the property is required. */
readonly required?: boolean;
/** @description Default value of the property */
- readonly default_value?: string | null;
+ readonly default_value?: (string | string[]) | null;
/** @description Short description of the property */
readonly description?: string | null;
- /** @description Ordered list of allowed values of the property */
+ /** @description An ordered list of the allowed values of the property.
+ * The property can have up to 200 allowed values. */
readonly allowed_values?: string[] | null;
};
};
@@ -99228,9 +91732,9 @@ export interface operations {
readonly "orgs/list-custom-properties-values-for-repos": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description Finds repositories in the organization with a query containing 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. */
readonly repository_query?: string;
@@ -99288,14 +91792,15 @@ export interface operations {
};
readonly 403: components["responses"]["forbidden"];
readonly 404: components["responses"]["not_found"];
+ readonly 422: components["responses"]["validation_failed"];
};
};
readonly "orgs/list-public-members": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -99405,9 +91910,9 @@ export interface operations {
readonly sort?: "created" | "updated" | "pushed" | "full_name";
/** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */
readonly direction?: "asc" | "desc";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -99578,7 +92083,7 @@ export interface operations {
readonly [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["repository"];
+ readonly "application/json": components["schemas"]["full-repository"];
};
};
readonly 403: components["responses"]["forbidden"];
@@ -99588,9 +92093,9 @@ export interface operations {
readonly "repos/get-org-rulesets": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -99632,10 +92137,12 @@ export interface operations {
/** @description The name of the ruleset. */
readonly name: string;
/**
- * @description The target of the ruleset.
+ * @description The target of the ruleset
+ *
+ * **Note**: The `push` target is in beta and is subject to change.
* @enum {string}
*/
- readonly target?: "branch" | "tag";
+ readonly target?: "branch" | "tag" | "push";
readonly enforcement: components["schemas"]["repository-rule-enforcement"];
/** @description The actors that can bypass the rules in this ruleset */
readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][];
@@ -99672,9 +92179,9 @@ export interface operations {
readonly actor_name?: components["parameters"]["actor-name-in-query"];
/** @description The rule results to filter on. When specified, only suites with this result will be returned. */
readonly rule_suite_result?: components["parameters"]["rule-suite-result"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -99775,10 +92282,12 @@ export interface operations {
/** @description The name of the ruleset. */
readonly name?: string;
/**
- * @description The target of the ruleset.
+ * @description The target of the ruleset
+ *
+ * **Note**: The `push` target is in beta and is subject to change.
* @enum {string}
*/
- readonly target?: "branch" | "tag";
+ readonly target?: "branch" | "tag" | "push";
readonly enforcement?: components["schemas"]["repository-rule-enforcement"];
/** @description The actors that can bypass the rules in this ruleset */
readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][];
@@ -99842,9 +92351,9 @@ export interface operations {
readonly sort?: components["parameters"]["secret-scanning-alert-sort"];
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */
readonly before?: components["parameters"]["secret-scanning-pagination-before-org-repo"];
@@ -99883,11 +92392,11 @@ export interface operations {
readonly direction?: components["parameters"]["direction"];
/** @description The property to sort the results by. */
readonly sort?: "created" | "updated" | "published";
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly before?: components["parameters"]["pagination-before"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly after?: components["parameters"]["pagination-after"];
- /** @description The number of advisories to return per page. */
+ /** @description The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: number;
/** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */
readonly state?: "triage" | "draft" | "published" | "closed";
@@ -100059,12 +92568,50 @@ export interface operations {
};
};
};
+ readonly "copilot/usage-metrics-for-team": {
+ readonly parameters: {
+ readonly query?: {
+ /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */
+ readonly since?: string;
+ /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */
+ readonly until?: string;
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ readonly page?: components["parameters"]["page"];
+ /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ readonly per_page?: number;
+ };
+ readonly header?: never;
+ readonly path: {
+ /** @description The organization name. The name is not case sensitive. */
+ readonly org: components["parameters"]["org"];
+ /** @description The slug of the team name. */
+ readonly team_slug: components["parameters"]["team-slug"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["copilot-usage-metrics"][];
+ };
+ };
+ readonly 401: components["responses"]["requires_authentication"];
+ readonly 403: components["responses"]["forbidden"];
+ readonly 404: components["responses"]["not_found"];
+ readonly 500: components["responses"]["internal_error"];
+ };
+ };
readonly "teams/list": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -100280,9 +92827,9 @@ export interface operations {
readonly query?: {
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description Pinned discussions only filter */
readonly pinned?: string;
@@ -100442,9 +92989,9 @@ export interface operations {
readonly query?: {
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -100603,9 +93150,9 @@ export interface operations {
readonly query?: {
/** @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. */
readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -100717,9 +93264,9 @@ export interface operations {
readonly query?: {
/** @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. */
readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -100823,9 +93370,9 @@ export interface operations {
readonly "teams/list-pending-invitations-in-org": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -100856,9 +93403,9 @@ export interface operations {
readonly query?: {
/** @description Filters members returned by their role in the team. */
readonly role?: "member" | "maintainer" | "all";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -101005,9 +93552,9 @@ export interface operations {
readonly "teams/list-projects-in-org": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -101085,7 +93632,7 @@ export interface operations {
readonly content: {
readonly "application/json": {
/**
- * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
* @enum {string}
*/
readonly permission?: "read" | "write" | "admin";
@@ -101142,9 +93689,9 @@ export interface operations {
readonly "teams/list-repos-in-org": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -101280,9 +93827,9 @@ export interface operations {
readonly "teams/list-child-in-org": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -101629,9 +94176,9 @@ export interface operations {
readonly query?: {
/** @description Filters the project cards that are returned by the card's state. */
readonly archived_state?: "all" | "archived" | "not_archived";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -101911,9 +94458,9 @@ export interface operations {
readonly query?: {
/** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */
readonly affiliation?: "outside" | "direct" | "all";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -102043,9 +94590,9 @@ export interface operations {
readonly "projects/list-columns": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -102385,9 +94932,9 @@ export interface operations {
readonly "actions/list-artifacts-for-repo": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */
readonly name?: components["parameters"]["artifact-name"];
@@ -102526,9 +95073,9 @@ export interface operations {
readonly "actions/get-actions-cache-list": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */
readonly ref?: components["parameters"]["actions-cache-git-ref-full"];
@@ -102776,9 +95323,9 @@ export interface operations {
readonly "actions/list-repo-organization-secrets": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -102810,9 +95357,9 @@ export interface operations {
readonly "actions/list-repo-organization-variables": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 30). */
+ /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["variables-per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -103064,9 +95611,9 @@ export interface operations {
readonly query?: {
/** @description The name of a self-hosted runner. */
readonly name?: string;
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -103385,11 +95932,11 @@ export interface operations {
readonly branch?: components["parameters"]["workflow-run-branch"];
/** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */
readonly event?: components["parameters"]["event"];
- /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */
+ /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */
readonly status?: components["parameters"]["workflow-run-status"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */
readonly created?: components["parameters"]["created"];
@@ -103540,9 +96087,9 @@ export interface operations {
readonly "actions/list-workflow-run-artifacts": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */
readonly name?: components["parameters"]["artifact-name"];
@@ -103610,9 +96157,9 @@ export interface operations {
readonly "actions/list-jobs-for-workflow-run-attempt": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -103765,9 +96312,9 @@ export interface operations {
readonly query?: {
/** @description Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run. */
readonly filter?: "latest" | "all";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -104034,9 +96581,9 @@ export interface operations {
readonly "actions/list-repo-secrets": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -104188,9 +96735,9 @@ export interface operations {
readonly "actions/list-repo-variables": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 30). */
+ /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["variables-per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -104342,9 +96889,9 @@ export interface operations {
readonly "actions/list-repo-workflows": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -104495,11 +97042,11 @@ export interface operations {
readonly branch?: components["parameters"]["workflow-run-branch"];
/** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */
readonly event?: components["parameters"]["event"];
- /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */
+ /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */
readonly status?: components["parameters"]["workflow-run-status"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */
readonly created?: components["parameters"]["created"];
@@ -104570,11 +97117,11 @@ export interface operations {
readonly query?: {
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly before?: components["parameters"]["pagination-before"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly after?: components["parameters"]["pagination-after"];
/** @description The Git reference for the activities you want to list.
*
@@ -104618,9 +97165,9 @@ export interface operations {
readonly "issues/list-assignees": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -104682,10 +97229,7 @@ export interface operations {
};
readonly "repos/list-autolinks": {
readonly parameters: {
- readonly query?: {
- /** @description Page number of the results to fetch. */
- readonly page?: components["parameters"]["page"];
- };
+ readonly query?: never;
readonly header?: never;
readonly path: {
/** @description The account owner of the repository. The name is not case sensitive. */
@@ -104887,9 +97431,9 @@ export interface operations {
readonly query?: {
/** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */
readonly protected?: boolean;
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -106144,11 +98688,11 @@ export interface operations {
/** @description A reference for the run on the integrator's system. */
readonly external_id?: string;
/**
- * @description The current status.
+ * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.
* @default queued
* @enum {string}
*/
- readonly status: "queued" | "in_progress" | "completed";
+ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
/**
* Format: date-time
* @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
@@ -106295,10 +98839,10 @@ export interface operations {
*/
readonly started_at?: string;
/**
- * @description The current status.
+ * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.
* @enum {string}
*/
- readonly status?: "queued" | "in_progress" | "completed";
+ readonly status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
/**
* @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check.
* **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.
@@ -106387,9 +98931,9 @@ export interface operations {
readonly "checks/list-annotations": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -106580,9 +99124,9 @@ export interface operations {
readonly status?: components["parameters"]["status"];
/** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */
readonly filter?: "latest" | "all";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -106647,9 +99191,9 @@ export interface operations {
readonly tool_name?: components["parameters"]["tool-name"];
/** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
readonly tool_guid?: components["parameters"]["tool-guid"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
/** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */
readonly ref?: components["parameters"]["git-ref"];
@@ -106760,9 +99304,9 @@ export interface operations {
readonly "code-scanning/list-alert-instances": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
/** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */
readonly ref?: components["parameters"]["git-ref"];
@@ -106801,9 +99345,9 @@ export interface operations {
readonly tool_name?: components["parameters"]["tool-name"];
/** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
readonly tool_guid?: components["parameters"]["tool-guid"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
/** @description The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */
readonly ref?: components["schemas"]["code-scanning-ref"];
@@ -107176,9 +99720,9 @@ export interface operations {
readonly "codespaces/list-in-repository-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -107282,9 +99826,9 @@ export interface operations {
readonly "codespaces/list-devcontainers-in-repository-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -107438,9 +99982,9 @@ export interface operations {
readonly "codespaces/list-repo-secrets": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -107596,9 +100140,9 @@ export interface operations {
readonly affiliation?: "outside" | "direct" | "all";
/** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */
readonly permission?: "pull" | "triage" | "push" | "maintain" | "admin";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -107764,9 +100308,9 @@ export interface operations {
readonly "repos/list-commit-comments-for-repo": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -107886,9 +100430,9 @@ export interface operations {
readonly query?: {
/** @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. */
readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -108006,9 +100550,9 @@ export interface operations {
readonly since?: components["parameters"]["since"];
/** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly until?: string;
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -108063,15 +100607,16 @@ export interface operations {
readonly "application/json": components["schemas"]["branch-short"][];
};
};
+ readonly 409: components["responses"]["conflict"];
readonly 422: components["responses"]["validation_failed"];
};
};
readonly "repos/list-comments-for-commit": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -108146,9 +100691,9 @@ export interface operations {
readonly "repos/list-pull-requests-associated-with-commit": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -108174,14 +100719,15 @@ export interface operations {
readonly "application/json": components["schemas"]["pull-request-simple"][];
};
};
+ readonly 409: components["responses"]["conflict"];
};
};
readonly "repos/get-commit": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -108207,6 +100753,7 @@ export interface operations {
};
};
readonly 404: components["responses"]["not_found"];
+ readonly 409: components["responses"]["conflict"];
readonly 422: components["responses"]["validation_failed"];
readonly 500: components["responses"]["internal_error"];
readonly 503: components["responses"]["service_unavailable"];
@@ -108221,9 +100768,9 @@ export interface operations {
readonly status?: components["parameters"]["status"];
/** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */
readonly filter?: "latest" | "all";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
readonly app_id?: number;
};
@@ -108265,9 +100812,9 @@ export interface operations {
readonly app_id?: number;
/** @description Returns check runs with the specified `name`. */
readonly check_name?: components["parameters"]["check-name"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -108301,9 +100848,9 @@ export interface operations {
readonly "repos/get-combined-status-for-ref": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -108334,9 +100881,9 @@ export interface operations {
readonly "repos/list-commit-statuses-for-ref": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -108393,9 +100940,9 @@ export interface operations {
readonly "repos/compare-commits": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -108590,9 +101137,9 @@ export interface operations {
readonly query?: {
/** @description Set to `1` or `true` to include anonymous contributors in results. */
readonly anon?: string;
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -108661,12 +101208,12 @@ export interface operations {
readonly page?: number;
/**
* @deprecated
- * @description The number of results per page (max 100).
+ * @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
*/
readonly per_page?: number;
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly before?: components["parameters"]["pagination-before"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly after?: components["parameters"]["pagination-after"];
/** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result.
* This parameter must not be used in combination with `last`.
@@ -108793,9 +101340,9 @@ export interface operations {
readonly "dependabot/list-repo-secrets": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -109054,9 +101601,9 @@ export interface operations {
readonly task?: string;
/** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */
readonly environment?: string | null;
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -109223,9 +101770,9 @@ export interface operations {
readonly "repos/list-deployment-statuses": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -109379,15 +101926,16 @@ export interface operations {
};
content?: never;
};
+ readonly 404: components["responses"]["not_found"];
readonly 422: components["responses"]["validation_failed"];
};
};
readonly "repos/get-all-environments": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -109428,7 +101976,7 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly environment_name: components["parameters"]["environment-name"];
};
readonly cookie?: never;
@@ -109455,7 +102003,7 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly environment_name: components["parameters"]["environment-name"];
};
readonly cookie?: never;
@@ -109508,7 +102056,7 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly environment_name: components["parameters"]["environment-name"];
};
readonly cookie?: never;
@@ -109527,9 +102075,9 @@ export interface operations {
readonly "repos/list-deployment-branch-policies": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -109538,7 +102086,7 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly environment_name: components["parameters"]["environment-name"];
};
readonly cookie?: never;
@@ -109572,7 +102120,7 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly environment_name: components["parameters"]["environment-name"];
};
readonly cookie?: never;
@@ -109617,7 +102165,7 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly environment_name: components["parameters"]["environment-name"];
/** @description The unique identifier of the branch policy. */
readonly branch_policy_id: components["parameters"]["branch-policy-id"];
@@ -109646,7 +102194,7 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly environment_name: components["parameters"]["environment-name"];
/** @description The unique identifier of the branch policy. */
readonly branch_policy_id: components["parameters"]["branch-policy-id"];
@@ -109679,7 +102227,7 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly environment_name: components["parameters"]["environment-name"];
/** @description The unique identifier of the branch policy. */
readonly branch_policy_id: components["parameters"]["branch-policy-id"];
@@ -109702,7 +102250,7 @@ export interface operations {
readonly query?: never;
readonly header?: never;
readonly path: {
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly environment_name: components["parameters"]["environment-name"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
@@ -109736,7 +102284,7 @@ export interface operations {
readonly query?: never;
readonly header?: never;
readonly path: {
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly environment_name: components["parameters"]["environment-name"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
@@ -109768,14 +102316,14 @@ export interface operations {
readonly "repos/list-custom-deployment-rule-integrations": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
readonly path: {
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly environment_name: components["parameters"]["environment-name"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
@@ -109813,7 +102361,7 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly environment_name: components["parameters"]["environment-name"];
/** @description The unique identifier of the protection rule. */
readonly protection_rule_id: components["parameters"]["protection-rule-id"];
@@ -109838,7 +102386,7 @@ export interface operations {
readonly query?: never;
readonly header?: never;
readonly path: {
- /** @description The name of the environment. */
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
readonly environment_name: components["parameters"]["environment-name"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
@@ -109860,12 +102408,340 @@ export interface operations {
};
};
};
+ readonly "actions/list-environment-secrets": {
+ readonly parameters: {
+ readonly query?: {
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ readonly per_page?: components["parameters"]["per-page"];
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ readonly page?: components["parameters"]["page"];
+ };
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
+ readonly environment_name: components["parameters"]["environment-name"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Response */
+ readonly 200: {
+ headers: {
+ readonly Link: components["headers"]["link"];
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": {
+ readonly total_count: number;
+ readonly secrets: components["schemas"]["actions-secret"][];
+ };
+ };
+ };
+ };
+ };
+ readonly "actions/get-environment-public-key": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
+ readonly environment_name: components["parameters"]["environment-name"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["actions-public-key"];
+ };
+ };
+ };
+ };
+ readonly "actions/get-environment-secret": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
+ readonly environment_name: components["parameters"]["environment-name"];
+ /** @description The name of the secret. */
+ readonly secret_name: components["parameters"]["secret-name"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["actions-secret"];
+ };
+ };
+ };
+ };
+ readonly "actions/create-or-update-environment-secret": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
+ readonly environment_name: components["parameters"]["environment-name"];
+ /** @description The name of the secret. */
+ readonly secret_name: components["parameters"]["secret-name"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody: {
+ readonly content: {
+ readonly "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 an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */
+ readonly encrypted_value: string;
+ /** @description ID of the key you used to encrypt the secret. */
+ readonly key_id: string;
+ };
+ };
+ };
+ readonly responses: {
+ /** @description Response when creating a secret */
+ readonly 201: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ /** @description Response when updating a secret */
+ readonly 204: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
+ readonly "actions/delete-environment-secret": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
+ readonly environment_name: components["parameters"]["environment-name"];
+ /** @description The name of the secret. */
+ readonly secret_name: components["parameters"]["secret-name"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Default response */
+ readonly 204: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
+ readonly "actions/list-environment-variables": {
+ readonly parameters: {
+ readonly query?: {
+ /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ readonly per_page?: components["parameters"]["variables-per-page"];
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ readonly page?: components["parameters"]["page"];
+ };
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
+ readonly environment_name: components["parameters"]["environment-name"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Response */
+ readonly 200: {
+ headers: {
+ readonly Link: components["headers"]["link"];
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": {
+ readonly total_count: number;
+ readonly variables: components["schemas"]["actions-variable"][];
+ };
+ };
+ };
+ };
+ };
+ readonly "actions/create-environment-variable": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
+ readonly environment_name: components["parameters"]["environment-name"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody: {
+ readonly content: {
+ readonly "application/json": {
+ /** @description The name of the variable. */
+ readonly name: string;
+ /** @description The value of the variable. */
+ readonly value: string;
+ };
+ };
+ };
+ readonly responses: {
+ /** @description Response */
+ readonly 201: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ };
+ };
+ readonly "actions/get-environment-variable": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
+ readonly environment_name: components["parameters"]["environment-name"];
+ /** @description The name of the variable. */
+ readonly name: components["parameters"]["variable-name"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["actions-variable"];
+ };
+ };
+ };
+ };
+ readonly "actions/delete-environment-variable": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ /** @description The name of the variable. */
+ readonly name: components["parameters"]["variable-name"];
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
+ readonly environment_name: components["parameters"]["environment-name"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Response */
+ readonly 204: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
+ readonly "actions/update-environment-variable": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ /** @description The name of the variable. */
+ readonly name: components["parameters"]["variable-name"];
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
+ readonly environment_name: components["parameters"]["environment-name"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody: {
+ readonly content: {
+ readonly "application/json": {
+ /** @description The name of the variable. */
+ readonly name?: string;
+ /** @description The value of the variable. */
+ readonly value?: string;
+ };
+ };
+ };
+ readonly responses: {
+ /** @description Response */
+ readonly 204: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
readonly "activity/list-repo-events": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -109895,9 +102771,9 @@ export interface operations {
readonly query?: {
/** @description The sort order. `stargazers` will sort by star count. */
readonly sort?: "newest" | "oldest" | "stargazers" | "watchers";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -110033,6 +102909,7 @@ export interface operations {
};
readonly 403: components["responses"]["forbidden"];
readonly 404: components["responses"]["not_found"];
+ readonly 409: components["responses"]["conflict"];
readonly 422: components["responses"]["validation_failed"];
};
};
@@ -110099,6 +102976,7 @@ export interface operations {
};
};
readonly 404: components["responses"]["not_found"];
+ readonly 409: components["responses"]["conflict"];
readonly 422: components["responses"]["validation_failed"];
};
};
@@ -110128,6 +103006,7 @@ export interface operations {
};
};
readonly 404: components["responses"]["not_found"];
+ readonly 409: components["responses"]["conflict"];
};
};
readonly "git/list-matching-refs": {
@@ -110139,8 +103018,11 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
- /** @description The commit reference. Can be a commit SHA, 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. */
- readonly ref: components["parameters"]["commit-ref"];
+ /**
+ * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
+ * @example heads/feature-a
+ */
+ readonly ref: components["parameters"]["git-ref-only"];
};
readonly cookie?: never;
};
@@ -110156,6 +103038,7 @@ export interface operations {
readonly "application/json": components["schemas"]["git-ref"][];
};
};
+ readonly 409: components["responses"]["conflict"];
};
};
readonly "git/get-ref": {
@@ -110167,8 +103050,11 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
- /** @description The commit reference. Can be a commit SHA, 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. */
- readonly ref: components["parameters"]["commit-ref"];
+ /**
+ * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
+ * @example heads/feature-a
+ */
+ readonly ref: components["parameters"]["git-ref-only"];
};
readonly cookie?: never;
};
@@ -110184,6 +103070,7 @@ export interface operations {
};
};
readonly 404: components["responses"]["not_found"];
+ readonly 409: components["responses"]["conflict"];
};
};
readonly "git/create-ref": {
@@ -110220,6 +103107,7 @@ export interface operations {
readonly "application/json": components["schemas"]["git-ref"];
};
};
+ readonly 409: components["responses"]["conflict"];
readonly 422: components["responses"]["validation_failed"];
};
};
@@ -110232,8 +103120,11 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
- /** @description The commit reference. Can be a commit SHA, 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. */
- readonly ref: components["parameters"]["commit-ref"];
+ /**
+ * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
+ * @example heads/feature-a
+ */
+ readonly ref: components["parameters"]["git-ref-only"];
};
readonly cookie?: never;
};
@@ -110246,6 +103137,7 @@ export interface operations {
};
content?: never;
};
+ readonly 409: components["responses"]["conflict"];
readonly 422: components["responses"]["validation_failed"];
};
};
@@ -110259,10 +103151,10 @@ export interface operations {
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
/**
- * @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
+ * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
+ * @example heads/feature-a
*/
- readonly ref: string;
+ readonly ref: components["parameters"]["git-ref-only"];
};
readonly cookie?: never;
};
@@ -110289,6 +103181,7 @@ export interface operations {
readonly "application/json": components["schemas"]["git-ref"];
};
};
+ readonly 409: components["responses"]["conflict"];
readonly 422: components["responses"]["validation_failed"];
};
};
@@ -110345,6 +103238,7 @@ export interface operations {
readonly "application/json": components["schemas"]["git-tag"];
};
};
+ readonly 409: components["responses"]["conflict"];
readonly 422: components["responses"]["validation_failed"];
};
};
@@ -110373,6 +103267,7 @@ export interface operations {
};
};
readonly 404: components["responses"]["not_found"];
+ readonly 409: components["responses"]["conflict"];
};
};
readonly "git/create-tree": {
@@ -110434,6 +103329,7 @@ export interface operations {
};
readonly 403: components["responses"]["forbidden"];
readonly 404: components["responses"]["not_found"];
+ readonly 409: components["responses"]["conflict"];
readonly 422: components["responses"]["validation_failed"];
};
};
@@ -110466,15 +103362,16 @@ export interface operations {
};
};
readonly 404: components["responses"]["not_found"];
+ readonly 409: components["responses"]["conflict"];
readonly 422: components["responses"]["validation_failed"];
};
};
readonly "repos/list-webhooks": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -110524,10 +103421,6 @@ export interface operations {
readonly content_type?: components["schemas"]["webhook-config-content-type"];
readonly secret?: components["schemas"]["webhook-config-secret"];
readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
- /** @example "abc" */
- readonly token?: string;
- /** @example "sha256" */
- readonly digest?: string;
};
/**
* @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.
@@ -110632,17 +103525,7 @@ export interface operations {
readonly requestBody: {
readonly content: {
readonly "application/json": {
- /** @description Key/value pairs to provide settings for this webhook. */
- readonly config?: {
- readonly url: components["schemas"]["webhook-config-url"];
- readonly content_type?: components["schemas"]["webhook-config-content-type"];
- readonly secret?: components["schemas"]["webhook-config-secret"];
- readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
- /** @example "bar@example.com" */
- readonly address?: string;
- /** @example "The Serious Room" */
- readonly room?: string;
- };
+ readonly config?: components["schemas"]["webhook-config"];
/**
* @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.
* @default [
@@ -110742,7 +103625,7 @@ export interface operations {
readonly "repos/list-webhook-deliveries": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
/** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */
readonly cursor?: components["parameters"]["cursor"];
@@ -111275,9 +104158,9 @@ export interface operations {
readonly "repos/list-invitations": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -111386,9 +104269,9 @@ export interface operations {
readonly direction?: components["parameters"]["direction"];
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since?: components["parameters"]["since"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -111480,9 +104363,9 @@ export interface operations {
readonly direction?: "asc" | "desc";
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since?: components["parameters"]["since"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -111603,9 +104486,9 @@ export interface operations {
readonly query?: {
/** @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. */
readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -111711,9 +104594,9 @@ export interface operations {
readonly "issues/list-events-for-repo": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -111973,9 +104856,9 @@ export interface operations {
readonly query?: {
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since?: components["parameters"]["since"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -112048,9 +104931,9 @@ export interface operations {
readonly "issues/list-events": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -112082,9 +104965,9 @@ export interface operations {
readonly "issues/list-labels-on-issue": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -112337,9 +105220,9 @@ export interface operations {
readonly query?: {
/** @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. */
readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -112446,9 +105329,9 @@ export interface operations {
readonly "issues/list-events-for-timeline": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -112481,9 +105364,9 @@ export interface operations {
readonly "repos/list-deploy-keys": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -112606,9 +105489,9 @@ export interface operations {
readonly "issues/list-labels-for-repo": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -112790,7 +105673,10 @@ export interface operations {
};
readonly "licenses/get-for-repo": {
readonly parameters: {
- readonly query?: never;
+ readonly query?: {
+ /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */
+ readonly ref?: components["parameters"]["git-ref"];
+ };
readonly header?: never;
readonly path: {
/** @description The account owner of the repository. The name is not case sensitive. */
@@ -112928,9 +105814,9 @@ export interface operations {
readonly sort?: "due_on" | "completeness";
/** @description The direction of the sort. Either `asc` or `desc`. */
readonly direction?: "asc" | "desc";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -113110,9 +105996,9 @@ export interface operations {
readonly "issues/list-labels-for-milestone": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -113151,9 +106037,234 @@ export interface operations {
readonly since?: components["parameters"]["since"];
/** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly before?: components["parameters"]["before"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ readonly per_page?: components["parameters"]["per-page"];
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ readonly page?: components["parameters"]["page"];
+ };
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Response */
+ readonly 200: {
+ headers: {
+ readonly Link: components["headers"]["link"];
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["thread"][];
+ };
+ };
+ };
+ };
+ readonly "activity/mark-repo-notifications-as-read": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: {
+ readonly content: {
+ readonly "application/json": {
+ /**
+ * Format: date-time
+ * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.
+ */
+ readonly last_read_at?: string;
+ };
+ };
+ };
+ readonly responses: {
+ /** @description Response */
+ readonly 202: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": {
+ readonly message?: string;
+ readonly url?: string;
+ };
+ };
+ };
+ /** @description Reset Content */
+ readonly 205: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
+ readonly "repos/get-pages": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["page"];
+ };
+ };
+ readonly 404: components["responses"]["not_found"];
+ };
+ };
+ readonly "repos/update-information-about-pages-site": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody: {
+ readonly content: {
+ readonly "application/json": {
+ /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */
+ readonly cname?: string | null;
+ /** @description Specify whether HTTPS should be enforced for the repository. */
+ readonly https_enforced?: boolean;
+ /**
+ * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.
+ * @enum {string}
+ */
+ readonly build_type?: "legacy" | "workflow";
+ readonly source?: ("gh-pages" | "master" | "master /docs") | {
+ /** @description The repository branch used to publish your site's source files. */
+ readonly branch: string;
+ /**
+ * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.
+ * @enum {string}
+ */
+ readonly path: "/" | "/docs";
+ };
+ } | unknown | unknown | unknown | unknown | unknown;
+ };
+ };
+ readonly responses: {
+ /** @description Response */
+ readonly 204: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content?: never;
+ };
+ readonly 400: components["responses"]["bad_request"];
+ readonly 409: components["responses"]["conflict"];
+ readonly 422: components["responses"]["validation_failed"];
+ };
+ };
+ readonly "repos/create-pages-site": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody: {
+ readonly content: {
+ readonly "application/json": ({
+ /**
+ * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`.
+ * @enum {string}
+ */
+ readonly build_type?: "legacy" | "workflow";
+ /** @description The source branch and directory used to publish your Pages site. */
+ readonly source?: {
+ /** @description The repository branch used to publish your site's source files. */
+ readonly branch: string;
+ /**
+ * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`
+ * @default /
+ * @enum {string}
+ */
+ readonly path: "/" | "/docs";
+ };
+ } | unknown | unknown) | null;
+ };
+ };
+ readonly responses: {
+ /** @description Response */
+ readonly 201: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["page"];
+ };
+ };
+ readonly 409: components["responses"]["conflict"];
+ readonly 422: components["responses"]["validation_failed"];
+ };
+ };
+ readonly "repos/delete-pages-site": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Response */
+ readonly 204: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content?: never;
+ };
+ readonly 404: components["responses"]["not_found"];
+ readonly 409: components["responses"]["conflict"];
+ readonly 422: components["responses"]["validation_failed"];
+ };
+ };
+ readonly "repos/list-pages-builds": {
+ readonly parameters: {
+ readonly query?: {
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -113174,12 +106285,12 @@ export interface operations {
readonly [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["thread"][];
+ readonly "application/json": components["schemas"]["page-build"][];
};
};
};
};
- readonly "activity/mark-repo-notifications-as-read": {
+ readonly "repos/request-pages-build": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
@@ -113191,40 +106302,20 @@ export interface operations {
};
readonly cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
- /**
- * Format: date-time
- * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.
- */
- readonly last_read_at?: string;
- };
- };
- };
+ readonly requestBody?: never;
readonly responses: {
/** @description Response */
- readonly 202: {
+ readonly 201: {
headers: {
readonly [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly message?: string;
- readonly url?: string;
- };
- };
- };
- /** @description Reset Content */
- readonly 205: {
- headers: {
- readonly [name: string]: unknown;
+ readonly "application/json": components["schemas"]["page-build-status"];
};
- content?: never;
};
};
};
- readonly "repos/get-pages": {
+ readonly "repos/get-latest-pages-build": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
@@ -113244,13 +106335,12 @@ export interface operations {
readonly [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["page"];
+ readonly "application/json": components["schemas"]["page-build"];
};
};
- readonly 404: components["responses"]["not_found"];
};
};
- readonly "repos/update-information-about-pages-site": {
+ readonly "repos/get-pages-build": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
@@ -113259,47 +106349,24 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
+ readonly build_id: number;
};
readonly cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */
- readonly cname?: string | null;
- /** @description Specify whether HTTPS should be enforced for the repository. */
- readonly https_enforced?: boolean;
- /**
- * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.
- * @enum {string}
- */
- readonly build_type?: "legacy" | "workflow";
- readonly source?: ("gh-pages" | "master" | "master /docs") | {
- /** @description The repository branch used to publish your site's source files. */
- readonly branch: string;
- /**
- * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.
- * @enum {string}
- */
- readonly path: "/" | "/docs";
- };
- } | unknown | unknown | unknown | unknown | unknown;
- };
- };
+ readonly requestBody?: never;
readonly responses: {
/** @description Response */
- readonly 204: {
+ readonly 200: {
headers: {
readonly [name: string]: unknown;
};
- content?: never;
+ content: {
+ readonly "application/json": components["schemas"]["page-build"];
+ };
};
- readonly 400: components["responses"]["bad_request"];
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/create-pages-site": {
+ readonly "repos/create-pages-deployment": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
@@ -113313,80 +106380,52 @@ export interface operations {
};
readonly requestBody: {
readonly content: {
- readonly "application/json": ({
+ readonly "application/json": {
+ /** @description The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */
+ readonly artifact_id?: number;
+ /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */
+ readonly artifact_url?: string;
/**
- * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`.
- * @enum {string}
+ * @description The target environment for this GitHub Pages deployment.
+ * @default github-pages
*/
- readonly build_type?: "legacy" | "workflow";
- /** @description The source branch and directory used to publish your Pages site. */
- readonly source?: {
- /** @description The repository branch used to publish your site's source files. */
- readonly branch: string;
- /**
- * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`
- * @default /
- * @enum {string}
- */
- readonly path: "/" | "/docs";
- };
- } | unknown | unknown) | null;
+ readonly environment: string;
+ /**
+ * @description A unique string that represents the version of the build for this deployment.
+ * @default GITHUB_SHA
+ */
+ readonly pages_build_version: string;
+ /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */
+ readonly oidc_token: string;
+ };
};
};
readonly responses: {
/** @description Response */
- readonly 201: {
+ readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["page"];
- };
- };
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed"];
- };
- };
- readonly "repos/delete-pages-site": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
- /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
+ readonly "application/json": components["schemas"]["page-deployment"];
};
- content?: never;
};
+ readonly 400: components["responses"]["bad_request"];
readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
readonly 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/list-pages-builds": {
+ readonly "repos/get-pages-deployment": {
readonly parameters: {
- readonly query?: {
- /** @description The number of results per page (max 100). */
- readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
- readonly page?: components["parameters"]["page"];
- };
+ readonly query?: never;
readonly header?: never;
readonly path: {
/** @description The account owner of the repository. The name is not case sensitive. */
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
+ /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */
+ readonly pages_deployment_id: components["parameters"]["pages-deployment-id"];
};
readonly cookie?: never;
};
@@ -113395,16 +106434,16 @@ export interface operations {
/** @description Response */
readonly 200: {
headers: {
- readonly Link: components["headers"]["link"];
readonly [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["page-build"][];
+ readonly "application/json": components["schemas"]["pages-deployment-status"];
};
};
+ readonly 404: components["responses"]["not_found"];
};
};
- readonly "repos/request-pages-build": {
+ readonly "repos/cancel-pages-deployment": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
@@ -113413,23 +106452,18 @@ export interface operations {
readonly owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
readonly repo: components["parameters"]["repo"];
+ /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */
+ readonly pages_deployment_id: components["parameters"]["pages-deployment-id"];
};
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
- /** @description Response */
- readonly 201: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["page-build-status"];
- };
- };
+ readonly 204: components["responses"]["no_content"];
+ readonly 404: components["responses"]["not_found"];
};
};
- readonly "repos/get-latest-pages-build": {
+ readonly "repos/get-pages-health-check": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
@@ -113449,85 +106483,36 @@ export interface operations {
readonly [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["page-build"];
+ readonly "application/json": components["schemas"]["pages-health-check"];
};
};
- };
- };
- readonly "repos/get-pages-build": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
- /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
- readonly build_id: number;
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
+ /** @description Empty response */
+ readonly 202: {
headers: {
readonly [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["page-build"];
+ readonly "application/json": components["schemas"]["empty-object"];
};
};
- };
- };
- readonly "repos/create-pages-deployment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
- /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
- };
- readonly cookie?: never;
- };
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. */
- readonly artifact_url: string;
- /**
- * @description The target environment for this GitHub Pages deployment.
- * @default github-pages
- */
- readonly environment: string;
- /**
- * @description A unique string that represents the version of the build for this deployment.
- * @default GITHUB_SHA
- */
- readonly pages_build_version: string;
- /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */
- readonly oidc_token: string;
+ /** @description Custom domains are not available for GitHub Pages */
+ readonly 400: {
+ headers: {
+ readonly [name: string]: unknown;
};
+ content?: never;
};
- };
- readonly responses: {
- /** @description Response */
- readonly 200: {
+ readonly 404: components["responses"]["not_found"];
+ /** @description There isn't a CNAME for this page */
+ readonly 422: {
headers: {
readonly [name: string]: unknown;
};
- content: {
- readonly "application/json": components["schemas"]["page-deployment"];
- };
+ content?: never;
};
- readonly 400: components["responses"]["bad_request"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-pages-health-check": {
+ readonly "repos/check-private-vulnerability-reporting": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
@@ -113541,39 +106526,19 @@ export interface operations {
};
readonly requestBody?: never;
readonly responses: {
- /** @description Response */
+ /** @description Private vulnerability reporting status */
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["pages-health-check"];
- };
- };
- /** @description Empty response */
- readonly 202: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["empty-object"];
- };
- };
- /** @description Custom domains are not available for GitHub Pages */
- readonly 400: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- readonly 404: components["responses"]["not_found"];
- /** @description There isn't a CNAME for this page */
- readonly 422: {
- headers: {
- readonly [name: string]: unknown;
+ readonly "application/json": {
+ /** @description Whether or not private vulnerability reporting is enabled for the repository. */
+ readonly enabled: boolean;
+ };
};
- content?: never;
};
+ readonly 422: components["responses"]["bad_request"];
};
};
readonly "repos/enable-private-vulnerability-reporting": {
@@ -113617,9 +106582,9 @@ export interface operations {
readonly query?: {
/** @description Indicates the state of the projects to return. */
readonly state?: "open" | "closed" | "all";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -113716,6 +106681,39 @@ export interface operations {
readonly 404: components["responses"]["not_found"];
};
};
+ readonly "repos/create-or-update-custom-properties-values": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody: {
+ readonly content: {
+ readonly "application/json": {
+ /** @description A list of custom property names and associated values to apply to the repositories. */
+ readonly properties: components["schemas"]["custom-property-value"][];
+ };
+ };
+ };
+ readonly responses: {
+ /** @description No Content when custom property values are successfully created or updated */
+ readonly 204: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content?: never;
+ };
+ readonly 403: components["responses"]["forbidden"];
+ readonly 404: components["responses"]["not_found"];
+ readonly 422: components["responses"]["validation_failed"];
+ };
+ };
readonly "pulls/list": {
readonly parameters: {
readonly query?: {
@@ -113729,9 +106727,9 @@ export interface operations {
readonly sort?: "created" | "updated" | "popularity" | "long-running";
/** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */
readonly direction?: "asc" | "desc";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -113825,9 +106823,9 @@ export interface operations {
readonly direction?: "asc" | "desc";
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since?: components["parameters"]["since"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -113946,9 +106944,9 @@ export interface operations {
readonly query?: {
/** @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. */
readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -114078,6 +107076,7 @@ export interface operations {
};
readonly 304: components["responses"]["not_modified"];
readonly 404: components["responses"]["not_found"];
+ readonly 406: components["responses"]["unacceptable"];
readonly 500: components["responses"]["internal_error"];
readonly 503: components["responses"]["service_unavailable"];
};
@@ -114206,9 +107205,9 @@ export interface operations {
readonly direction?: "asc" | "desc";
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since?: components["parameters"]["since"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -114261,7 +107260,7 @@ export interface operations {
readonly path: string;
/**
* @deprecated
- * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
+ * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
*/
readonly position?: number;
/**
@@ -114349,9 +107348,9 @@ export interface operations {
readonly "pulls/list-commits": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -114382,9 +107381,9 @@ export interface operations {
readonly "pulls/list-files": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -114629,9 +107628,9 @@ export interface operations {
readonly "pulls/list-reviews": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -114689,7 +107688,7 @@ export interface operations {
readonly comments?: {
/** @description The relative path to the file that necessitates a review comment. */
readonly path: string;
- /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below. */
+ /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */
readonly position?: number;
/** @description Text of the review comment. */
readonly body: string;
@@ -114820,9 +107819,9 @@ export interface operations {
readonly "pulls/list-comments-for-review": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -115044,9 +108043,9 @@ export interface operations {
readonly "repos/list-releases": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -115346,7 +108345,7 @@ export interface operations {
};
readonly requestBody?: never;
readonly responses: {
- /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */
+ /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */
readonly 200: {
headers: {
readonly [name: string]: unknown;
@@ -115453,9 +108452,9 @@ export interface operations {
readonly "repos/list-release-assets": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -115529,9 +108528,9 @@ export interface operations {
readonly query?: {
/** @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. */
readonly content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -115637,9 +108636,9 @@ export interface operations {
readonly "repos/get-branch-rules": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -115669,9 +108668,9 @@ export interface operations {
readonly "repos/get-repo-rulesets": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description Include rulesets configured at higher levels that apply to this repository */
readonly includes_parents?: boolean;
@@ -115719,10 +108718,12 @@ export interface operations {
/** @description The name of the ruleset. */
readonly name: string;
/**
- * @description The target of the ruleset.
+ * @description The target of the ruleset
+ *
+ * **Note**: The `push` target is in beta and is subject to change.
* @enum {string}
*/
- readonly target?: "branch" | "tag";
+ readonly target?: "branch" | "tag" | "push";
readonly enforcement: components["schemas"]["repository-rule-enforcement"];
/** @description The actors that can bypass the rules in this ruleset */
readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][];
@@ -115759,9 +108760,9 @@ export interface operations {
readonly actor_name?: components["parameters"]["actor-name-in-query"];
/** @description The rule results to filter on. When specified, only suites with this result will be returned. */
readonly rule_suite_result?: components["parameters"]["rule-suite-result"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -115873,10 +108874,12 @@ export interface operations {
/** @description The name of the ruleset. */
readonly name?: string;
/**
- * @description The target of the ruleset.
+ * @description The target of the ruleset
+ *
+ * **Note**: The `push` target is in beta and is subject to change.
* @enum {string}
*/
- readonly target?: "branch" | "tag";
+ readonly target?: "branch" | "tag" | "push";
readonly enforcement?: components["schemas"]["repository-rule-enforcement"];
/** @description The actors that can bypass the rules in this ruleset */
readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][];
@@ -115942,9 +108945,9 @@ export interface operations {
readonly sort?: components["parameters"]["secret-scanning-alert-sort"];
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */
readonly before?: components["parameters"]["secret-scanning-pagination-before-org-repo"];
@@ -116079,9 +109082,9 @@ export interface operations {
readonly "secret-scanning/list-locations-for-alert": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -116124,11 +109127,11 @@ export interface operations {
readonly direction?: components["parameters"]["direction"];
/** @description The property to sort the results by. */
readonly sort?: "created" | "updated" | "published";
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly before?: components["parameters"]["pagination-before"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly after?: components["parameters"]["pagination-after"];
- /** @description Number of advisories to return per page. */
+ /** @description The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: number;
/** @description Filter by state of the repository advisories. Only advisories of this state will be returned. */
readonly state?: "triage" | "draft" | "published" | "closed";
@@ -116315,12 +109318,43 @@ export interface operations {
readonly 422: components["responses"]["validation_failed"];
};
};
+ readonly "security-advisories/create-fork": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ readonly owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ readonly repo: components["parameters"]["repo"];
+ /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */
+ readonly ghsa_id: components["parameters"]["ghsa_id"];
+ };
+ readonly cookie?: never;
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Response */
+ readonly 202: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["full-repository"];
+ };
+ };
+ readonly 400: components["responses"]["bad_request"];
+ readonly 403: components["responses"]["forbidden"];
+ readonly 404: components["responses"]["not_found"];
+ readonly 422: components["responses"]["validation_failed"];
+ };
+ };
readonly "activity/list-stargazers-for-repo": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -116372,6 +109406,13 @@ export interface operations {
};
readonly 202: components["responses"]["accepted"];
readonly 204: components["responses"]["no_content"];
+ /** @description Repository contains more than 10,000 commits */
+ readonly 422: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content?: never;
+ };
};
};
readonly "repos/get-commit-activity-stats": {
@@ -116532,9 +109573,9 @@ export interface operations {
readonly "activity/list-watchers-for-repo": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -116653,9 +109694,9 @@ export interface operations {
readonly "repos/list-tags": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -116798,9 +109839,9 @@ export interface operations {
readonly "repos/list-teams": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -116830,9 +109871,9 @@ export interface operations {
readonly "repos/get-all-topics": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -117183,7 +110224,7 @@ export interface operations {
readonly [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["repository"];
+ readonly "application/json": components["schemas"]["full-repository"];
};
};
};
@@ -117215,314 +110256,6 @@ export interface operations {
readonly 422: components["responses"]["validation_failed"];
};
};
- readonly "actions/list-environment-secrets": {
- readonly parameters: {
- readonly query?: {
- /** @description The number of results per page (max 100). */
- readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
- readonly page?: components["parameters"]["page"];
- };
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
- /** @description The name of the environment. */
- readonly environment_name: components["parameters"]["environment-name"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly secrets: components["schemas"]["actions-secret"][];
- };
- };
- };
- };
- };
- readonly "actions/get-environment-public-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
- /** @description The name of the environment. */
- readonly environment_name: components["parameters"]["environment-name"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["actions-public-key"];
- };
- };
- };
- };
- readonly "actions/get-environment-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
- /** @description The name of the environment. */
- readonly environment_name: components["parameters"]["environment-name"];
- /** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["actions-secret"];
- };
- };
- };
- };
- readonly "actions/create-or-update-environment-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
- /** @description The name of the environment. */
- readonly environment_name: components["parameters"]["environment-name"];
- /** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
- };
- readonly cookie?: never;
- };
- readonly requestBody: {
- readonly content: {
- readonly "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 an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */
- readonly encrypted_value: string;
- /** @description ID of the key you used to encrypt the secret. */
- readonly key_id: string;
- };
- };
- };
- readonly responses: {
- /** @description Response when creating a secret */
- readonly 201: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["empty-object"];
- };
- };
- /** @description Response when updating a secret */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- };
- };
- readonly "actions/delete-environment-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
- /** @description The name of the environment. */
- readonly environment_name: components["parameters"]["environment-name"];
- /** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Default response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- };
- };
- readonly "actions/list-environment-variables": {
- readonly parameters: {
- readonly query?: {
- /** @description The number of results per page (max 30). */
- readonly per_page?: components["parameters"]["variables-per-page"];
- /** @description Page number of the results to fetch. */
- readonly page?: components["parameters"]["page"];
- };
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
- /** @description The name of the environment. */
- readonly environment_name: components["parameters"]["environment-name"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly variables: components["schemas"]["actions-variable"][];
- };
- };
- };
- };
- };
- readonly "actions/create-environment-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
- /** @description The name of the environment. */
- readonly environment_name: components["parameters"]["environment-name"];
- };
- readonly cookie?: never;
- };
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /** @description The name of the variable. */
- readonly name: string;
- /** @description The value of the variable. */
- readonly value: string;
- };
- };
- };
- readonly responses: {
- /** @description Response */
- readonly 201: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["empty-object"];
- };
- };
- };
- };
- readonly "actions/get-environment-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
- /** @description The name of the environment. */
- readonly environment_name: components["parameters"]["environment-name"];
- /** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["actions-variable"];
- };
- };
- };
- };
- readonly "actions/delete-environment-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
- /** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
- /** @description The name of the environment. */
- readonly environment_name: components["parameters"]["environment-name"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- };
- };
- readonly "actions/update-environment-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
- /** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
- /** @description The name of the environment. */
- readonly environment_name: components["parameters"]["environment-name"];
- };
- readonly cookie?: never;
- };
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /** @description The name of the variable. */
- readonly name?: string;
- /** @description The value of the variable. */
- readonly value?: string;
- };
- };
- };
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- };
- };
readonly "search/code": {
readonly parameters: {
readonly query: {
@@ -117538,9 +110271,9 @@ export interface operations {
* @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.
*/
readonly order?: "desc" | "asc";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -117577,9 +110310,9 @@ export interface operations {
readonly sort?: "author-date" | "committer-date";
/** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
readonly order?: components["parameters"]["order"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -117613,9 +110346,9 @@ export interface operations {
readonly sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated";
/** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
readonly order?: components["parameters"]["order"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -117654,9 +110387,9 @@ export interface operations {
readonly sort?: "created" | "updated";
/** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
readonly order?: components["parameters"]["order"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -117693,9 +110426,9 @@ export interface operations {
readonly sort?: "stars" | "forks" | "help-wanted-issues" | "updated";
/** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
readonly order?: components["parameters"]["order"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -117727,9 +110460,9 @@ export interface operations {
readonly 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). */
readonly q: string;
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -117763,9 +110496,9 @@ export interface operations {
readonly sort?: "followers" | "repositories" | "joined";
/** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
readonly order?: components["parameters"]["order"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -117913,9 +110646,9 @@ export interface operations {
readonly query?: {
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -118063,9 +110796,9 @@ export interface operations {
readonly query?: {
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -118214,9 +110947,9 @@ export interface operations {
readonly query?: {
/** @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. */
readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -118286,9 +111019,9 @@ export interface operations {
readonly query?: {
/** @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. */
readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -118352,9 +111085,9 @@ export interface operations {
readonly "teams/list-pending-invitations-legacy": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -118383,9 +111116,9 @@ export interface operations {
readonly query?: {
/** @description Filters members returned by their role in the team. */
readonly role?: "member" | "maintainer" | "all";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -118618,9 +111351,9 @@ export interface operations {
readonly "teams/list-projects-legacy": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -118693,7 +111426,7 @@ export interface operations {
readonly content: {
readonly "application/json": {
/**
- * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
* @enum {string}
*/
readonly permission?: "read" | "write" | "admin";
@@ -118752,9 +111485,9 @@ export interface operations {
readonly "teams/list-repos-legacy": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -118885,9 +111618,9 @@ export interface operations {
readonly "teams/list-child-legacy": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -119004,9 +111737,9 @@ export interface operations {
readonly "users/list-blocked-by-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -119117,9 +111850,9 @@ export interface operations {
readonly "codespaces/list-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description ID of the Repository to filter on */
readonly repository_id?: components["parameters"]["repository-id-in-query"];
@@ -119240,9 +111973,9 @@ export interface operations {
readonly "codespaces/list-secrets-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -119820,9 +112553,9 @@ export interface operations {
readonly "users/list-emails-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -119915,9 +112648,9 @@ export interface operations {
readonly "users/list-followers-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -119944,9 +112677,9 @@ export interface operations {
readonly "users/list-followed-by-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -120056,9 +112789,9 @@ export interface operations {
readonly "users/list-gpg-keys-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -120173,9 +112906,9 @@ export interface operations {
readonly "apps/list-installations-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -120205,9 +112938,9 @@ export interface operations {
readonly "apps/list-installation-repos-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -120382,9 +113115,9 @@ export interface operations {
readonly direction?: components["parameters"]["direction"];
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since?: components["parameters"]["since"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -120410,9 +113143,9 @@ export interface operations {
readonly "users/list-public-ssh-keys-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -120529,9 +113262,9 @@ export interface operations {
readonly "apps/list-subscriptions-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -120558,9 +113291,9 @@ export interface operations {
readonly "apps/list-subscriptions-for-authenticated-user-stubbed": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -120588,9 +113321,9 @@ export interface operations {
readonly query?: {
/** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */
readonly state?: "active" | "pending";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -120679,9 +113412,9 @@ export interface operations {
readonly "migrations/list-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -120886,9 +113619,9 @@ export interface operations {
readonly "migrations/list-repos-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -120916,9 +113649,9 @@ export interface operations {
readonly "orgs/list-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -120952,9 +113685,9 @@ export interface operations {
* The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.
* For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */
readonly visibility?: components["parameters"]["package-visibility"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -121058,9 +113791,9 @@ export interface operations {
readonly "packages/get-all-package-versions-for-package-owned-by-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
/** @description The state of the package, either active or deleted. */
readonly state?: "active" | "deleted";
@@ -121215,9 +113948,9 @@ export interface operations {
readonly "users/list-public-emails-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -121258,9 +113991,9 @@ export interface operations {
readonly sort?: "created" | "updated" | "pushed" | "full_name";
/** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */
readonly direction?: "asc" | "desc";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
/** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since?: components["parameters"]["since-repo-date"];
@@ -121441,7 +114174,7 @@ export interface operations {
readonly [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["repository"];
+ readonly "application/json": components["schemas"]["full-repository"];
};
};
readonly 304: components["responses"]["not_modified"];
@@ -121455,9 +114188,9 @@ export interface operations {
readonly "repos/list-invitations-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -121535,9 +114268,9 @@ export interface operations {
readonly "users/list-social-accounts-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -121633,9 +114366,9 @@ export interface operations {
readonly "users/list-ssh-signing-keys-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -121756,9 +114489,9 @@ export interface operations {
readonly sort?: components["parameters"]["sort-starred"];
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -121875,9 +114608,9 @@ export interface operations {
readonly "activity/list-watched-repos-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -121904,9 +114637,9 @@ export interface operations {
readonly "teams/list-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -121935,7 +114668,7 @@ export interface operations {
readonly query?: {
/** @description A user ID. Only return users with an ID greater than this ID. */
readonly since?: components["parameters"]["since-user"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -122010,9 +114743,9 @@ export interface operations {
readonly "activity/list-events-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122038,9 +114771,9 @@ export interface operations {
readonly "activity/list-org-events-for-authenticated-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122068,9 +114801,9 @@ export interface operations {
readonly "activity/list-public-events-for-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122096,9 +114829,9 @@ export interface operations {
readonly "users/list-followers-for-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122125,9 +114858,9 @@ export interface operations {
readonly "users/list-following-for-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122185,9 +114918,9 @@ export interface operations {
readonly query?: {
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
readonly since?: components["parameters"]["since"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122215,9 +114948,9 @@ export interface operations {
readonly "users/list-gpg-keys-for-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122297,9 +115030,9 @@ export interface operations {
readonly "users/list-public-keys-for-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122326,9 +115059,9 @@ export interface operations {
readonly "orgs/list-for-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122362,9 +115095,9 @@ export interface operations {
* The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.
* For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */
readonly visibility?: components["parameters"]["package-visibility"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
};
readonly header?: never;
@@ -122600,9 +115333,9 @@ export interface operations {
readonly query?: {
/** @description Indicates the state of the projects to return. */
readonly state?: "open" | "closed" | "all";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122630,9 +115363,9 @@ export interface operations {
readonly "activity/list-received-events-for-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122658,9 +115391,9 @@ export interface operations {
readonly "activity/list-received-public-events-for-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122692,9 +115425,9 @@ export interface operations {
readonly sort?: "created" | "updated" | "pushed" | "full_name";
/** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */
readonly direction?: "asc" | "desc";
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122790,9 +115523,9 @@ export interface operations {
readonly "users/list-social-accounts-for-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122819,9 +115552,9 @@ export interface operations {
readonly "users/list-ssh-signing-keys-for-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122852,9 +115585,9 @@ export interface operations {
readonly sort?: components["parameters"]["sort-starred"];
/** @description The direction to sort the results by. */
readonly direction?: components["parameters"]["direction"];
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122881,9 +115614,9 @@ export interface operations {
readonly "activity/list-repos-watched-by-user": {
readonly parameters: {
readonly query?: {
- /** @description The number of results per page (max 100). */
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly per_page?: components["parameters"]["per-page"];
- /** @description Page number of the results to fetch. */
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
readonly page?: components["parameters"]["page"];
};
readonly header?: never;
@@ -122948,4 +115681,4 @@ export interface operations {
};
};
};
-}
\ No newline at end of file
+}
diff --git a/packages/openapi-typescript/examples/github-api-immutable.ts b/packages/openapi-typescript/examples/github-api-immutable.ts
index de4eab409..1ec780f66 100644
--- a/packages/openapi-typescript/examples/github-api-immutable.ts
+++ b/packages/openapi-typescript/examples/github-api-immutable.ts
@@ -231,9 +231,9 @@ export interface paths {
};
/**
* List installations for the authenticated app
- * @description 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.
+ * @description The permissions the installation has are included under the `permissions` key.
*
- * The permissions the installation has are included under the `permissions` key.
+ * 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.
*/
readonly get: operations["apps/list-installations"];
readonly put?: never;
@@ -283,7 +283,13 @@ export interface paths {
readonly put?: never;
/**
* Create an installation access token for an app
- * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.
+ * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.
+ *
+ * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.
+ *
+ * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.
+ *
+ * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.
*
* 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.
*/
@@ -382,7 +388,15 @@ export interface paths {
readonly put?: never;
/**
* Create a scoped access token
- * @description Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`.
+ * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify
+ * which repositories the token can access and which permissions are granted to the
+ * token.
+ *
+ * Invalid tokens will return `404 NOT FOUND`.
+ *
+ * You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)
+ * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App
+ * as the username and password.
*/
readonly post: operations["apps/scope-token"];
readonly delete?: never;
@@ -401,8 +415,6 @@ export interface paths {
/**
* Get an app
* @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).
- *
- * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.
*/
readonly get: operations["apps/get-by-slug"];
readonly put?: never;
@@ -593,6 +605,39 @@ export interface paths {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/enterprises/{enterprise}/copilot/usage": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get a summary of Copilot usage for enterprise members
+ * @description **Note**: This endpoint is in beta and is subject to change.
+ *
+ * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
+ * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,
+ * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.
+ *
+ * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,
+ * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
+ * they must have telemetry enabled in their IDE.
+ *
+ * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage
+ * metrics for the enterprise.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint.
+ */
+ readonly get: operations["copilot/usage-metrics-for-enterprise"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/enterprises/{enterprise}/dependabot/alerts": {
readonly parameters: {
readonly query?: never;
@@ -603,9 +648,12 @@ export interface paths {
/**
* List Dependabot alerts for an enterprise
* @description Lists Dependabot alerts for repositories that are owned by the specified enterprise.
- * To use this endpoint, you must be a member of the enterprise, and you must use an
- * access token with the `repo` scope or `security_events` scope.
+ *
+ * The authenticated user must be a member of the enterprise to use this endpoint.
+ *
* Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, 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)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.
*/
readonly get: operations["dependabot/list-alerts-for-enterprise"];
readonly put?: never;
@@ -626,7 +674,12 @@ export interface paths {
/**
* List secret scanning alerts for an enterprise
* @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.
- * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).
+ *
+ * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).
+ *
+ * The authenticated user must be a member of the enterprise in order to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.
*/
readonly get: operations["secret-scanning/list-alerts-for-enterprise"];
readonly put?: never;
@@ -666,16 +719,18 @@ export interface paths {
};
/**
* Get feeds
- * @description GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:
+ * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
*
* * **Timeline**: The GitHub global public timeline
- * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)
+ * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."
* * **Current user public**: The public timeline for the authenticated user
* * **Current user**: The private timeline for the authenticated user
* * **Current user actor**: The private timeline for activity created by the authenticated user
* * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.
* * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.
*
+ * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
* **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.
*/
readonly get: operations["activity/get-feeds"];
@@ -762,7 +817,15 @@ export interface paths {
readonly path?: never;
readonly cookie?: never;
};
- /** Get a gist */
+ /**
+ * Get a gist
+ * @description Gets a specified gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
readonly get: operations["gists/get"];
readonly put?: never;
readonly post?: never;
@@ -772,8 +835,16 @@ export interface paths {
readonly head?: never;
/**
* Update a gist
- * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
+ * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files
+ * from the previous version of the gist that aren't explicitly changed during an edit
+ * are unchanged.
+ *
* At least one of `description` or `files` is required.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
*/
readonly patch: operations["gists/update"];
readonly trace?: never;
@@ -785,10 +856,26 @@ export interface paths {
readonly path?: never;
readonly cookie?: never;
};
- /** List gist comments */
+ /**
+ * List gist comments
+ * @description Lists the comments on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
readonly get: operations["gists/list-comments"];
readonly put?: never;
- /** Create a gist comment */
+ /**
+ * Create a gist comment
+ * @description Creates a comment on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
readonly post: operations["gists/create-comment"];
readonly delete?: never;
readonly options?: never;
@@ -803,7 +890,15 @@ export interface paths {
readonly path?: never;
readonly cookie?: never;
};
- /** Get a gist comment */
+ /**
+ * Get a gist comment
+ * @description Gets a comment on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
readonly get: operations["gists/get-comment"];
readonly put?: never;
readonly post?: never;
@@ -811,7 +906,15 @@ export interface paths {
readonly delete: operations["gists/delete-comment"];
readonly options?: never;
readonly head?: never;
- /** Update a gist comment */
+ /**
+ * Update a gist comment
+ * @description Updates a comment on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
readonly patch: operations["gists/update-comment"];
readonly trace?: never;
};
@@ -861,7 +964,7 @@ export interface paths {
readonly get: operations["gists/check-is-starred"];
/**
* Star a gist
- * @description Note that 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)."
+ * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
readonly put: operations["gists/star"];
readonly post?: never;
@@ -879,7 +982,15 @@ export interface paths {
readonly path?: never;
readonly cookie?: never;
};
- /** Get a gist revision */
+ /**
+ * Get a gist revision
+ * @description Gets a specified gist revision.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
readonly get: operations["gists/get-revision"];
readonly put?: never;
readonly post?: never;
@@ -918,8 +1029,11 @@ export interface paths {
};
/**
* Get a gitignore template
- * @description The API also allows fetching the source of a single template.
- * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents.
+ * @description Get the content of a gitignore template.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.
*/
readonly get: operations["gitignore/get-template"];
readonly put?: never;
@@ -940,8 +1054,6 @@ export interface paths {
/**
* List repositories accessible to the app installation
* @description List repositories that an app installation can access.
- *
- * 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.
*/
readonly get: operations["apps/list-repos-accessible-to-installation"];
readonly put?: never;
@@ -967,8 +1079,6 @@ export interface 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/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.
*/
readonly delete: operations["apps/revoke-installation-access-token"];
readonly options?: never;
@@ -989,11 +1099,17 @@ export interface paths {
* repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not
* necessarily assigned to you.
*
- *
* **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/list"];
readonly put?: never;
@@ -1294,7 +1410,11 @@ export interface paths {
readonly get: operations["activity/get-thread"];
readonly put?: never;
readonly post?: never;
- readonly delete?: never;
+ /**
+ * Mark a thread as done
+ * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.
+ */
+ readonly delete: operations["activity/mark-thread-as-done"];
readonly options?: never;
readonly head?: never;
/**
@@ -1367,7 +1487,7 @@ export interface paths {
};
/**
* List organizations
- * @description Lists all organizations, in the order that they were created on GitHub.
+ * @description Lists all organizations, in the order that they were created.
*
* **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.
*/
@@ -1389,9 +1509,26 @@ export interface paths {
};
/**
* Get an organization
- * @description To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).
+ * @description Gets information about an organization.
+ *
+ * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).
+ *
+ * To see the full details about an organization, the authenticated user must be an organization owner.
+ *
+ * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration:
*
- * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below."
+ * - advanced_security_enabled_for_new_repositories
+ * - dependabot_alerts_enabled_for_new_repositories
+ * - dependabot_security_updates_enabled_for_new_repositories
+ * - dependency_graph_enabled_for_new_repositories
+ * - secret_scanning_enabled_for_new_repositories
+ * - secret_scanning_push_protection_enabled_for_new_repositories
+ *
+ * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.
+ *
+ * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.
*/
readonly get: operations["orgs/get"];
readonly put?: never;
@@ -1413,7 +1550,22 @@ export interface paths {
* Update an organization
* @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).
*
- * Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges.
+ * Updates the organization's profile and member privileges.
+ *
+ * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:
+ *
+ * - advanced_security_enabled_for_new_repositories
+ * - dependabot_alerts_enabled_for_new_repositories
+ * - dependabot_security_updates_enabled_for_new_repositories
+ * - dependency_graph_enabled_for_new_repositories
+ * - secret_scanning_enabled_for_new_repositories
+ * - secret_scanning_push_protection_enabled_for_new_repositories
+ *
+ * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)."
+ *
+ * The authenticated user must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.
*/
readonly patch: operations["orgs/update"];
readonly trace?: never;
@@ -1429,7 +1581,8 @@ export interface paths {
* Get GitHub Actions cache usage for an organization
* @description Gets the total GitHub Actions cache usage for an organization.
* The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
*/
readonly get: operations["actions/get-actions-cache-usage-for-org"];
readonly put?: never;
@@ -1451,7 +1604,8 @@ export interface paths {
* List repositories with GitHub Actions cache usage for an organization
* @description Lists repositories and their GitHub Actions cache usage for an organization.
* The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
*/
readonly get: operations["actions/get-actions-cache-usage-by-repo-for-org"];
readonly put?: never;
@@ -1472,15 +1626,15 @@ export interface paths {
/**
* Get the customization template for an OIDC subject claim for an organization
* @description Gets the customization template for an OpenID Connect (OIDC) subject claim.
- * You must authenticate using an access token with the `read:org` scope to use this endpoint.
- * GitHub Apps must have the `organization_administration:write` permission to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
*/
readonly get: operations["oidc/get-oidc-custom-sub-template-for-org"];
/**
* Set the customization template for an OIDC subject claim for an organization
* @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.
- * You must authenticate using an access token with the `write:org` scope to use this endpoint.
- * GitHub Apps must have the `admin:org` permission to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
*/
readonly put: operations["oidc/update-oidc-custom-sub-template-for-org"];
readonly post?: never;
@@ -1501,14 +1655,14 @@ export interface paths {
* Get GitHub Actions permissions for an organization
* @description Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["actions/get-github-actions-permissions-organization"];
/**
* Set GitHub Actions permissions for an organization
* @description Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["actions/set-github-actions-permissions-organization"];
readonly post?: never;
@@ -1529,14 +1683,15 @@ export interface paths {
* List selected repositories enabled for GitHub Actions in an organization
* @description Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["actions/list-selected-repositories-enabled-github-actions-organization"];
/**
* Set selected repositories enabled for GitHub Actions in an organization
* @description Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["actions/set-selected-repositories-enabled-github-actions-organization"];
readonly post?: never;
@@ -1558,7 +1713,7 @@ export interface paths {
* Enable a selected repository for GitHub Actions in an organization
* @description Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["actions/enable-selected-repository-github-actions-organization"];
readonly post?: never;
@@ -1566,7 +1721,7 @@ export interface paths {
* Disable a selected repository for GitHub Actions in an organization
* @description Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["actions/disable-selected-repository-github-actions-organization"];
readonly options?: never;
@@ -1583,16 +1738,16 @@ export interface paths {
};
/**
* Get allowed actions and reusable workflows for an organization
- * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).""
+ * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["actions/get-allowed-actions-organization"];
/**
* Set allowed actions and reusable workflows for an organization
* @description Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["actions/set-allowed-actions-organization"];
readonly post?: never;
@@ -1615,7 +1770,7 @@ export interface paths {
* as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
* "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["actions/get-github-actions-default-workflow-permissions-organization"];
/**
@@ -1624,7 +1779,7 @@ export interface paths {
* can submit approving pull request reviews. For more information, see
* "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["actions/set-github-actions-default-workflow-permissions-organization"];
readonly post?: never;
@@ -1645,10 +1800,9 @@ export interface paths {
* List self-hosted runners for an organization
* @description Lists all self-hosted runners configured in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-self-hosted-runners-for-org"];
readonly put?: never;
@@ -1670,10 +1824,9 @@ export interface paths {
* List runner applications for an organization
* @description Lists binaries for the runner application that you can download and run.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-runner-applications-for-org"];
readonly put?: never;
@@ -1697,10 +1850,9 @@ export interface paths {
* Create configuration for a just-in-time runner for an organization
* @description Generates a configuration that can be passed to the runner application at startup.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * The authenticated user must have admin access to the organization.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/generate-runner-jitconfig-for-org"];
readonly delete?: never;
@@ -1722,18 +1874,15 @@ export interface paths {
* Create a registration token for an organization
* @description Returns a token that you can pass to the `config` script. The token expires after one hour.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
- *
- * Example using registration token:
- *
- * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
*
* ```
* ./config.sh --url https://github.com/octo-org --token TOKEN
* ```
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-registration-token-for-org"];
readonly delete?: never;
@@ -1755,19 +1904,15 @@ export interface paths {
* Create a remove token for an organization
* @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
- *
- * Example using remove token:
- *
- * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this
- * endpoint.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:
*
* ```
* ./config.sh remove --token TOKEN
* ```
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-remove-token-for-org"];
readonly delete?: never;
@@ -1787,10 +1932,9 @@ export interface paths {
* Get a self-hosted runner for an organization
* @description Gets a specific self-hosted runner configured in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/get-self-hosted-runner-for-org"];
readonly put?: never;
@@ -1799,10 +1943,9 @@ export interface paths {
* Delete a self-hosted runner from an organization
* @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-self-hosted-runner-from-org"];
readonly options?: never;
@@ -1821,10 +1964,9 @@ export interface paths {
* List labels for a self-hosted runner for an organization
* @description Lists all labels for a self-hosted runner configured in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-labels-for-self-hosted-runner-for-org"];
/**
@@ -1832,20 +1974,18 @@ export interface paths {
* @description Remove all previous custom labels and set the new custom labels for a specific
* self-hosted runner configured in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"];
/**
* Add custom labels to a self-hosted runner for an organization
- * @description Add custom labels to a self-hosted runner configured in an organization.
+ * @description Adds custom labels to a self-hosted runner configured in an organization.
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"];
/**
@@ -1853,10 +1993,9 @@ export interface paths {
* @description Remove all custom labels from a self-hosted runner configured in an
* organization. Returns the remaining read-only labels from the runner.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"];
readonly options?: never;
@@ -1882,10 +2021,9 @@ export interface paths {
* This endpoint returns a `404 Not Found` status if the custom label is not
* present on the runner.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"];
readonly options?: never;
@@ -1905,10 +2043,9 @@ export interface paths {
* @description Lists all secrets available in an organization without revealing their
* encrypted values.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-org-secrets"];
readonly put?: never;
@@ -1931,10 +2068,9 @@ export interface paths {
* @description Gets your public key, which you need to encrypt secrets. You need to
* encrypt a secret before you can create or update secrets.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ * The authenticated user must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-org-public-key"];
readonly put?: never;
@@ -1956,10 +2092,9 @@ export interface paths {
* Get an organization secret
* @description Gets a single organization secret without revealing its encrypted value.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ * The authenticated user must have collaborator access to a repository to create, update, or read secrets
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-org-secret"];
/**
@@ -1967,10 +2102,9 @@ export interface paths {
* @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/create-or-update-org-secret"];
readonly post?: never;
@@ -1978,10 +2112,9 @@ export interface paths {
* Delete an organization secret
* @description Deletes a secret in an organization using the secret name.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-org-secret"];
readonly options?: never;
@@ -2001,10 +2134,9 @@ export interface paths {
* @description Lists all repositories that have been selected when the `visibility`
* for repository access to a secret is set to `selected`.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-selected-repos-for-org-secret"];
/**
@@ -2013,10 +2145,9 @@ export interface paths {
* for repository access is set to `selected`. The visibility is set when you [Create
* or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly put: operations["actions/set-selected-repos-for-org-secret"];
readonly post?: never;
@@ -2037,13 +2168,12 @@ export interface paths {
/**
* Add selected repository to an organization secret
* @description Adds a repository to an organization secret when the `visibility` for
- * repository access is set to `selected`. The visibility is set when you [Create or
+ * repository access is set to `selected`. For more information about setting the visibility, see [Create or
* update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/add-selected-repo-to-org-secret"];
readonly post?: never;
@@ -2053,10 +2183,9 @@ export interface paths {
* for repository access is set to `selected`. The visibility is set when you [Create
* or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly delete: operations["actions/remove-selected-repo-from-org-secret"];
readonly options?: never;
@@ -2074,7 +2203,10 @@ export interface paths {
/**
* List organization variables
* @description Lists all organization variables.
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-org-variables"];
readonly put?: never;
@@ -2082,10 +2214,9 @@ export interface paths {
* Create an organization variable
* @description Creates an organization variable that you can reference in a GitHub Actions workflow.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-org-variable"];
readonly delete?: never;
@@ -2105,10 +2236,9 @@ export interface paths {
* Get an organization variable
* @description Gets a specific variable in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ * The authenticated user must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-org-variable"];
readonly put?: never;
@@ -2117,10 +2247,9 @@ export interface paths {
* Delete an organization variable
* @description Deletes an organization variable using the variable name.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-org-variable"];
readonly options?: never;
@@ -2129,10 +2258,9 @@ export interface paths {
* Update an organization variable
* @description Updates an organization variable that you can reference in a GitHub Actions workflow.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly patch: operations["actions/update-org-variable"];
readonly trace?: never;
@@ -2149,10 +2277,9 @@ export interface paths {
* @description Lists all repositories that can access an organization variable
* that is available to selected repositories.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly get: operations["actions/list-selected-repos-for-org-variable"];
/**
@@ -2161,11 +2288,9 @@ export interface paths {
* to selected repositories. Organization variables that are available to selected
* repositories have their `visibility` field set to `selected`.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this
- * endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly put: operations["actions/set-selected-repos-for-org-variable"];
readonly post?: never;
@@ -2188,10 +2313,9 @@ export interface paths {
* @description Adds a repository to an organization variable that is available to selected repositories.
* Organization variables that are available to selected repositories have their `visibility` field set to `selected`.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/add-selected-repo-to-org-variable"];
readonly post?: never;
@@ -2201,10 +2325,9 @@ export interface paths {
* available to selected repositories. Organization variables that are available to
* selected repositories have their `visibility` field set to `selected`.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
readonly delete: operations["actions/remove-selected-repo-from-org-variable"];
readonly options?: never;
@@ -2271,9 +2394,9 @@ export interface paths {
* List code scanning alerts for an organization
* @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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)."
*
- * 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 `security_events` scope.
+ * The authenticated user must be an owner or security manager for the organization to use this endpoint.
*
- * For public repositories, you may instead use the `public_repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/list-alerts-for-org"];
readonly put?: never;
@@ -2295,7 +2418,7 @@ export interface paths {
* List codespaces for the organization
* @description Lists the codespaces associated to a specified organization.
*
- * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-in-organization"];
readonly put?: never;
@@ -2318,7 +2441,7 @@ export interface paths {
* Manage access control for organization codespaces
* @deprecated
* @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.
- * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["codespaces/set-codespaces-access"];
readonly post?: never;
@@ -2345,7 +2468,7 @@ export interface paths {
* To use this endpoint, the access settings for the organization must be set to `selected_members`.
* For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."
*
- * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly post: operations["codespaces/set-codespaces-access-users"];
/**
@@ -2356,7 +2479,7 @@ export interface paths {
* To use this endpoint, the access settings for the organization must be set to `selected_members`.
* For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."
*
- * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["codespaces/delete-codespaces-access-users"];
readonly options?: never;
@@ -2373,8 +2496,10 @@ export interface paths {
};
/**
* List organization secrets
- * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values.
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted
+ * values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-org-secrets"];
readonly put?: never;
@@ -2394,7 +2519,8 @@ export interface paths {
};
/**
* Get an organization public key
- * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-org-public-key"];
readonly put?: never;
@@ -2415,7 +2541,8 @@ export interface paths {
/**
* Get an organization secret
* @description Gets an organization development environment secret without revealing its encrypted value.
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-org-secret"];
/**
@@ -2423,14 +2550,15 @@ export interface paths {
* @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access
- * token with the `admin:org` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["codespaces/create-or-update-org-secret"];
readonly post?: never;
/**
* Delete an organization secret
- * @description Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Deletes an organization development environment secret using the secret name.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["codespaces/delete-org-secret"];
readonly options?: never;
@@ -2447,12 +2575,19 @@ export interface paths {
};
/**
* List selected repositories for an organization secret
- * @description Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Lists all repositories that have been selected when the `visibility`
+ * for repository access to a secret is set to `selected`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-selected-repos-for-org-secret"];
/**
* Set selected repositories for an organization secret
- * @description Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Replaces all repositories for an organization development environment secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["codespaces/set-selected-repos-for-org-secret"];
readonly post?: never;
@@ -2472,13 +2607,18 @@ export interface paths {
readonly get?: never;
/**
* Add selected repository to an organization secret
- * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["codespaces/add-selected-repo-to-org-secret"];
readonly post?: never;
/**
* Remove selected repository from an organization secret
- * @description Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * @description Removes a repository from an organization development environment secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["codespaces/remove-selected-repo-from-org-secret"];
readonly options?: never;
@@ -2494,15 +2634,16 @@ export interface paths {
readonly cookie?: never;
};
/**
- * Get Copilot Business seat information and settings for an organization
+ * Get Copilot seat information and settings for an organization
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Gets information about an organization's Copilot Business subscription, including seat breakdown
+ * Gets information about an organization's Copilot subscription, including seat breakdown
* and code matching policies. To configure these settings, go to your organization's settings on GitHub.com.
- * For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)".
+ * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)".
+ *
+ * Only organization owners can configure and view details about the organization's Copilot Business subscription.
*
- * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must
- * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
readonly get: operations["copilot/get-copilot-organization-details"];
readonly put?: never;
@@ -2521,13 +2662,14 @@ export interface paths {
readonly cookie?: never;
};
/**
- * List all Copilot Business seat assignments for an organization
+ * List all Copilot seat assignments for an organization
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).
+ * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).
*
- * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must
- * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
readonly get: operations["copilot/list-copilot-seats"];
readonly put?: never;
@@ -2548,33 +2690,35 @@ export interface paths {
readonly get?: never;
readonly put?: never;
/**
- * Add teams to the Copilot Business subscription for an organization
+ * Add teams to the Copilot subscription for an organization
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Purchases a GitHub Copilot Business seat for all users within each specified team.
- * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)".
+ * Purchases a GitHub Copilot seat for all users within each specified team.
+ * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
+ *
+ * Only organization owners can configure GitHub Copilot in their organization.
*
- * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
- * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.
+ * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)".
+ * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
*
- * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy.
- * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)".
- * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
- readonly post: operations["copilot/add-copilot-for-business-seats-for-teams"];
+ readonly post: operations["copilot/add-copilot-seats-for-teams"];
/**
- * Remove teams from the Copilot Business subscription for an organization
+ * Remove teams from the Copilot subscription for an organization
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Cancels the Copilot Business seat assignment for all members of each team specified.
+ * Cancels the Copilot seat assignment for all members of each team specified.
* This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.
*
- * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)".
+ * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
*
- * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
+ * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
*
- * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
- * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * Only organization owners can configure GitHub Copilot in their organization.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
readonly delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"];
readonly options?: never;
@@ -2592,33 +2736,35 @@ export interface paths {
readonly get?: never;
readonly put?: never;
/**
- * Add users to the Copilot Business subscription for an organization
+ * Add users to the Copilot subscription for an organization
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Purchases a GitHub Copilot Business seat for each user specified.
- * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)".
+ * Purchases a GitHub Copilot seat for each user specified.
+ * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
+ *
+ * Only organization owners can configure GitHub Copilot in their organization.
*
- * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
- * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.
+ * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)".
+ * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
*
- * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy.
- * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)".
- * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
- readonly post: operations["copilot/add-copilot-for-business-seats-for-users"];
+ readonly post: operations["copilot/add-copilot-seats-for-users"];
/**
- * Remove users from the Copilot Business subscription for an organization
+ * Remove users from the Copilot subscription for an organization
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Cancels the Copilot Business seat assignment for each user specified.
+ * Cancels the Copilot seat assignment for each user specified.
* This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.
*
- * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)"
+ * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
*
- * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
+ * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
*
- * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
- * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * Only organization owners can configure GitHub Copilot in their organization.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
readonly delete: operations["copilot/cancel-copilot-seat-assignment-for-users"];
readonly options?: never;
@@ -2626,6 +2772,39 @@ export interface paths {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/orgs/{org}/copilot/usage": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get a summary of Copilot usage for organization members
+ * @description **Note**: This endpoint is in beta and is subject to change.
+ *
+ * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
+ * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
+ * See the response schema tab for detailed metrics definitions.
+ *
+ * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,
+ * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
+ * they must have telemetry enabled in their IDE.
+ *
+ * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view
+ * Copilot usage metrics.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint.
+ */
+ readonly get: operations["copilot/usage-metrics-for-org"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/orgs/{org}/dependabot/alerts": {
readonly parameters: {
readonly query?: never;
@@ -2637,11 +2816,9 @@ export interface paths {
* List Dependabot alerts for an organization
* @description Lists Dependabot alerts 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 `security_events` scope.
+ * The authenticated user must be an owner or security manager for the organization to use this endpoint.
*
- * For public repositories, you may instead use the `public_repo` scope.
- *
- * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["dependabot/list-alerts-for-org"];
readonly put?: never;
@@ -2661,7 +2838,10 @@ export interface paths {
};
/**
* List organization secrets
- * @description Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Lists all secrets available in an organization without revealing their
+ * encrypted values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["dependabot/list-org-secrets"];
readonly put?: never;
@@ -2681,7 +2861,10 @@ export interface paths {
};
/**
* Get an organization public key
- * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["dependabot/get-org-public-key"];
readonly put?: never;
@@ -2701,7 +2884,9 @@ export interface paths {
};
/**
* Get an organization secret
- * @description Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Gets a single organization secret without revealing its encrypted value.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["dependabot/get-org-secret"];
/**
@@ -2709,15 +2894,15 @@ export interface paths {
* @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access
- * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization
- * permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["dependabot/create-or-update-org-secret"];
readonly post?: never;
/**
* Delete an organization secret
- * @description Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Deletes a secret in an organization using the secret name.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["dependabot/delete-org-secret"];
readonly options?: never;
@@ -2734,12 +2919,19 @@ export interface paths {
};
/**
* List selected repositories for an organization secret
- * @description Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Lists all repositories that have been selected when the `visibility`
+ * for repository access to a secret is set to `selected`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["dependabot/list-selected-repos-for-org-secret"];
/**
* Set selected repositories for an organization secret
- * @description Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Replaces all repositories for an organization secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["dependabot/set-selected-repos-for-org-secret"];
readonly post?: never;
@@ -2759,13 +2951,21 @@ export interface paths {
readonly get?: never;
/**
* Add selected repository to an organization secret
- * @description Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Adds a repository to an organization secret when the `visibility` for
+ * repository access is set to `selected`. The visibility is set when you [Create or
+ * update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["dependabot/add-selected-repo-to-org-secret"];
readonly post?: never;
/**
* Remove selected repository from an organization secret
- * @description Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
+ * @description Removes a repository from an organization secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["dependabot/remove-selected-repo-from-org-secret"];
readonly options?: never;
@@ -2783,7 +2983,8 @@ export interface paths {
/**
* Get list of conflicting packages during Docker migration for organization
* @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
*/
readonly get: operations["packages/list-docker-migration-conflicting-packages-for-organization"];
readonly put?: never;
@@ -2838,12 +3039,23 @@ export interface paths {
readonly path?: never;
readonly cookie?: never;
};
- /** List organization webhooks */
+ /**
+ * List organization webhooks
+ * @description You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
+ */
readonly get: operations["orgs/list-webhooks"];
readonly put?: never;
/**
* Create an organization webhook
- * @description Here's how you can create a hook that posts payloads in JSON format:
+ * @description Create a hook that posts payloads in JSON format.
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or
+ * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly post: operations["orgs/create-webhook"];
readonly delete?: never;
@@ -2861,18 +3073,39 @@ export interface paths {
};
/**
* Get an organization webhook
- * @description Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)."
+ * @description Returns a webhook configured in an organization. To get only the webhook
+ * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly get: operations["orgs/get-webhook"];
readonly put?: never;
readonly post?: never;
- /** Delete an organization webhook */
+ /**
+ * Delete an organization webhook
+ * @description You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
+ */
readonly delete: operations["orgs/delete-webhook"];
readonly options?: never;
readonly head?: never;
/**
* Update an organization webhook
- * @description Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. 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 an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)."
+ * @description Updates a webhook configured in an organization. When you update a webhook,
+ * the `secret` will be overwritten. 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 an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)".
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly patch: operations["orgs/update-webhook"];
readonly trace?: never;
@@ -2888,7 +3121,10 @@ export interface paths {
* Get a webhook configuration for an organization
* @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)."
*
- * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly get: operations["orgs/get-webhook-config-for-org"];
readonly put?: never;
@@ -2900,7 +3136,10 @@ export interface paths {
* Update a webhook configuration for an organization
* @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)."
*
- * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly patch: operations["orgs/update-webhook-config-for-org"];
readonly trace?: never;
@@ -2915,6 +3154,11 @@ export interface paths {
/**
* List deliveries for an organization webhook
* @description Returns a list of webhook deliveries for a webhook configured in an organization.
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly get: operations["orgs/list-webhook-deliveries"];
readonly put?: never;
@@ -2935,6 +3179,11 @@ export interface paths {
/**
* Get a webhook delivery for an organization webhook
* @description Returns a delivery for a webhook configured in an organization.
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly get: operations["orgs/get-webhook-delivery"];
readonly put?: never;
@@ -2957,6 +3206,11 @@ export interface paths {
/**
* Redeliver a delivery for an organization webhook
* @description Redeliver a delivery for a webhook configured in an organization.
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly post: operations["orgs/redeliver-webhook-delivery"];
readonly delete?: never;
@@ -2976,7 +3230,13 @@ export interface paths {
readonly put?: never;
/**
* Ping an organization webhook
- * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.
+ * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)
+ * to be sent to the hook.
+ *
+ * You must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
+ * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
*/
readonly post: operations["orgs/ping-webhook"];
readonly delete?: never;
@@ -3016,7 +3276,12 @@ export interface paths {
};
/**
* List app installations for an organization
- * @description Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.
+ * @description Lists all GitHub Apps in an organization. The installation count includes
+ * all GitHub Apps installed on repositories in the organization.
+ *
+ * The authenticated user must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint.
*/
readonly get: operations["orgs/list-app-installations"];
readonly put?: never;
@@ -3139,6 +3404,13 @@ export interface paths {
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/list-for-org"];
readonly put?: never;
@@ -3204,7 +3476,7 @@ export interface paths {
* List codespaces for a user in organization
* @description Lists the codespaces that a member of an organization has for repositories in that organization.
*
- * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-codespaces-for-user-in-org"];
readonly put?: never;
@@ -3229,10 +3501,7 @@ export interface paths {
* Delete a codespace from the organization
* @description Deletes a user's codespace.
*
- * To use this endpoint you must authenticate using one of the following methods:
- *
- * - An access token with the `admin:org` scope
- * - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces`
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["codespaces/delete-from-organization"];
readonly options?: never;
@@ -3253,10 +3522,7 @@ export interface paths {
* Stop a codespace for an organization user
* @description Stops a user's codespace.
*
- * To use this endpoint you must authenticate using one of the following methods:
- *
- * - An access token with the `admin:org` scope
- * - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces`
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly post: operations["codespaces/stop-in-organization"];
readonly delete?: never;
@@ -3273,12 +3539,14 @@ export interface paths {
readonly cookie?: never;
};
/**
- * Get Copilot Business seat assignment details for a user
+ * Get Copilot seat assignment details for a user
* @description **Note**: This endpoint is in beta and is subject to change.
*
- * Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot.
+ * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.
+ *
+ * Organization owners can view GitHub Copilot seat assignment details for members in their organization.
*
- * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
readonly get: operations["copilot/get-copilot-seat-details-for-user"];
readonly put?: never;
@@ -3453,9 +3721,7 @@ export interface paths {
};
/**
* List organization fine-grained permissions for an organization
- * @description **Note**: This operation is in beta and subject to change.
- *
- * Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
* To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)."
*
@@ -3464,8 +3730,7 @@ export interface paths {
* - An administrator for the organization.
* - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.
*
- * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint.
- * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["orgs/list-organization-fine-grained-permissions"];
readonly put?: never;
@@ -3485,33 +3750,27 @@ export interface paths {
};
/**
* Get all organization roles for an organization
- * @description Lists the organization roles available in this organization.
+ * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
* To use this endpoint, the authenticated user must be one of:
*
* - An administrator for the organization.
* - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.
*
- * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint.
- * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint.
- *
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["orgs/list-org-roles"];
readonly put?: never;
/**
* Create a custom organization role
- * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization.
+ * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
* To use this endpoint, the authenticated user must be one of:
*
* - An administrator for the organization.
* - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.
*
- * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint.
- * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint.
- *
- * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly post: operations["orgs/create-custom-organization-role"];
readonly delete?: never;
@@ -3532,12 +3791,11 @@ export interface paths {
readonly post?: never;
/**
* Remove all organization roles for a team
- * @description Removes all assigned organization roles from a team.
+ * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members:write` organization permission to use this endpoint.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["orgs/revoke-all-org-roles-team"];
readonly options?: never;
@@ -3555,22 +3813,21 @@ export interface paths {
readonly get?: never;
/**
* Assign an organization role to a team
- * @description Assigns an organization role to a team in an organization.
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members` organization read-write permission to use this endpoint.
+ * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ *
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["orgs/assign-team-to-org-role"];
readonly post?: never;
/**
* Remove an organization role from a team
- * @description Removes an organization role from a team.
+ * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members:write` organization permission to use this endpoint.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["orgs/revoke-org-role-team"];
readonly options?: never;
@@ -3590,12 +3847,11 @@ export interface paths {
readonly post?: never;
/**
* Remove all organization roles for a user
- * @description Revokes all assigned organization roles from a user.
+ * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members:write` organization permission to use this endpoint.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["orgs/revoke-all-org-roles-user"];
readonly options?: never;
@@ -3613,22 +3869,21 @@ export interface paths {
readonly get?: never;
/**
* Assign an organization role to a user
- * @description Assigns an organization role to a member of an organization.
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members` organization read-write permission to use this endpoint.
+ * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * The authenticated user must be an administrator for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly put: operations["orgs/assign-user-to-org-role"];
readonly post?: never;
/**
* Remove an organization role from a user
- * @description Remove an organization role from a user.
+ * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members:write` organization permission to use this endpoint.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["orgs/revoke-org-role-user"];
readonly options?: never;
@@ -3645,51 +3900,43 @@ export interface paths {
};
/**
* Get an organization role
- * @description Gets an organization role that is available to this organization.
+ * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
* To use this endpoint, the authenticated user must be one of:
*
* - An administrator for the organization.
* - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.
*
- * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint.
- * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint.
- *
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["orgs/get-org-role"];
readonly put?: never;
readonly post?: never;
/**
* Delete a custom organization role.
- * @description Deletes a custom organization role.
+ * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
* To use this endpoint, the authenticated user must be one of:
*
* - An administrator for the organization.
* - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.
*
- * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint.
- * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint.
- *
- * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["orgs/delete-custom-organization-role"];
readonly options?: never;
readonly head?: never;
/**
* Update a custom organization role
- * @description Updates an existing custom organization role. Permission changes will apply to all assignees.
+ * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ *
*
* To use this endpoint, the authenticated user must be one of:
*
* - An administrator for the organization.
* - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.
*
- * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint.
- * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint.
- *
- * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly patch: operations["orgs/patch-custom-organization-role"];
readonly trace?: never;
@@ -3703,12 +3950,11 @@ export interface paths {
};
/**
* List teams that are assigned to an organization role
- * @description Lists the teams that are assigned to an organization role.
+ * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members` organization read permission to use this endpoint.
+ * To use this endpoint, you must be an administrator for the organization.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["orgs/list-org-role-teams"];
readonly put?: never;
@@ -3728,12 +3974,11 @@ export interface paths {
};
/**
* List users that are assigned to an organization role
- * @description Lists organization members that are assigned to an organization role.
+ * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- * GitHub Apps must have the `members` organization read permission to use this endpoint.
+ * To use this endpoint, you must be an administrator for the organization.
*
- * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly get: operations["orgs/list-org-role-users"];
readonly put?: never;
@@ -3799,7 +4044,7 @@ export interface paths {
* List packages for an organization
* @description Lists packages in an organization readable by the user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/list-packages-for-organization"];
readonly put?: never;
@@ -3821,7 +4066,7 @@ export interface paths {
* Get a package for an organization
* @description Gets a specific package in an organization.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-package-for-organization"];
readonly put?: never;
@@ -3830,9 +4075,9 @@ export interface paths {
* Delete a package for an organization
* @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly delete: operations["packages/delete-package-for-org"];
readonly options?: never;
@@ -3857,9 +4102,9 @@ export interface paths {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly post: operations["packages/restore-package-for-org"];
readonly delete?: never;
@@ -3879,7 +4124,7 @@ export interface paths {
* List package versions for a package owned by an organization
* @description Lists package versions for a package owned by an organization.
*
- * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-all-package-versions-for-package-owned-by-org"];
readonly put?: never;
@@ -3901,7 +4146,7 @@ export interface paths {
* Get a package version for an organization
* @description Gets a specific package version in an organization.
*
- * You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-package-version-for-organization"];
readonly put?: never;
@@ -3910,9 +4155,9 @@ export interface paths {
* Delete package version for an organization
* @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly delete: operations["packages/delete-package-version-for-org"];
readonly options?: never;
@@ -3937,9 +4182,9 @@ export interface paths {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly post: operations["packages/restore-package-version-for-org"];
readonly delete?: never;
@@ -3957,19 +4202,17 @@ export interface paths {
};
/**
* List requests to access organization resources with fine-grained personal access tokens
- * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API,
- * using the `organization_personal_access_token_requests: read` permission.
+ * @description Lists requests from organization members to access organization resources with a fine-grained personal access token.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly get: operations["orgs/list-pat-grant-requests"];
readonly put?: never;
/**
* Review requests to access organization resources with fine-grained personal access tokens
- * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,
- * using the `organization_personal_access_token_requests: write` permission.
+ * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly post: operations["orgs/review-pat-grant-requests-in-bulk"];
readonly delete?: never;
@@ -3989,10 +4232,9 @@ export interface paths {
readonly put?: never;
/**
* Review a request to access organization resources with a fine-grained personal access token
- * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,
- * using the `organization_personal_access_token_requests: write` permission.
+ * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly post: operations["orgs/review-pat-grant-request"];
readonly delete?: never;
@@ -4010,10 +4252,9 @@ export interface paths {
};
/**
* List repositories requested to be accessed by a fine-grained personal access token
- * @description Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API,
- * using the `organization_personal_access_token_requests: read` permission.
+ * @description Lists the repositories a fine-grained personal access token request is requesting access to.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly get: operations["orgs/list-pat-grant-request-repositories"];
readonly put?: never;
@@ -4033,19 +4274,17 @@ export interface paths {
};
/**
* List fine-grained personal access tokens with access to organization resources
- * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API,
- * using the `organization_personal_access_tokens: read` permission.
+ * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly get: operations["orgs/list-pat-grants"];
readonly put?: never;
/**
* Update the access to organization resources via fine-grained personal access tokens
- * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API,
- * using the `organization_personal_access_tokens: write` permission.
+ * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly post: operations["orgs/update-pat-accesses"];
readonly delete?: never;
@@ -4065,10 +4304,9 @@ export interface paths {
readonly put?: never;
/**
* Update the access a fine-grained personal access token has to organization resources
- * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API,
- * using the `organization_personal_access_tokens: write` permission.
+ * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly post: operations["orgs/update-pat-access"];
readonly delete?: never;
@@ -4086,10 +4324,9 @@ export interface paths {
};
/**
* List repositories a fine-grained personal access token has access to
- * @description Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API,
- * using the `organization_personal_access_tokens: read` permission.
+ * @description Lists the repositories a fine-grained personal access token has access to.
*
- * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
+ * Only GitHub Apps can use this endpoint.
*/
readonly get: operations["orgs/list-pat-grant-repositories"];
readonly put?: never;
@@ -4134,7 +4371,7 @@ export interface paths {
/**
* Get all custom properties for an organization
* @description Gets all custom properties defined for an organization.
- * You must be an organization owner to use this endpoint.
+ * Organization members can read these properties.
*/
readonly get: operations["orgs/get-all-custom-properties"];
readonly put?: never;
@@ -4145,7 +4382,10 @@ export interface paths {
/**
* Create or update custom properties for an organization
* @description Creates new or updates existing custom properties defined for an organization in a batch.
- * Only organization owners (or users with the proper permissions granted by them) can update these properties
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
*/
readonly patch: operations["orgs/create-or-update-custom-properties"];
readonly trace?: never;
@@ -4160,20 +4400,26 @@ export interface paths {
/**
* Get a custom property for an organization
* @description Gets a custom property that is defined for an organization.
- * You must be an organization owner to use this endpoint.
+ * Organization members can read these properties.
*/
readonly get: operations["orgs/get-custom-property"];
/**
* Create or update a custom property for an organization
* @description Creates a new or updates an existing custom property that is defined for an organization.
- * You must be an organization owner to use this endpoint.
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
*/
readonly put: operations["orgs/create-or-update-custom-property"];
readonly post?: never;
/**
* Remove a custom property for an organization
* @description Removes a custom property that is defined for an organization.
- * You must be an organization owner to use this endpoint.
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
*/
readonly delete: operations["orgs/remove-custom-property"];
readonly options?: never;
@@ -4208,7 +4454,9 @@ export interface paths {
*
* Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.
*
- * Only organization owners (or users with the proper permissions granted by them) can update these properties
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.
*/
readonly patch: operations["orgs/create-or-update-custom-properties-values-for-repos"];
readonly trace?: never;
@@ -4249,7 +4497,7 @@ export interface paths {
* Set public organization membership for the authenticated user
* @description The user can publicize their own membership. (A user cannot publicize the membership for another user.)
*
- * Note that 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)."
+ * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
readonly put: operations["orgs/set-public-membership-for-authenticated-user"];
readonly post?: never;
@@ -4282,12 +4530,7 @@ export interface paths {
* Create an organization repository
* @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
*
- * **OAuth scope requirements**
- *
- * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
- *
- * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- * * `repo` scope to create a private repository
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
*/
readonly post: operations["repos/create-in-org"];
readonly delete?: never;
@@ -4400,10 +4643,10 @@ export interface paths {
/**
* List secret scanning alerts for an organization
* @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.
- * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * The authenticated user must be an administrator or security manager for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["secret-scanning/list-alerts-for-org"];
readonly put?: never;
@@ -4425,7 +4668,9 @@ export interface paths {
* 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.
+ * The authenticated user must be an owner or security manager for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
*/
readonly get: operations["security-advisories/list-org-repository-advisories"];
readonly put?: never;
@@ -4447,9 +4692,9 @@ export interface paths {
* 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)."
*
- * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope.
+ * The authenticated user must be an administrator or security manager for the organization to use this endpoint.
*
- * GitHub Apps must have the `administration` organization read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
*/
readonly get: operations["orgs/list-security-manager-teams"];
readonly put?: never;
@@ -4472,9 +4717,9 @@ export interface paths {
* Add a security manager team
* @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * GitHub Apps must have the `administration` organization read-write permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
*/
readonly put: operations["orgs/add-security-manager-team"];
readonly post?: never;
@@ -4482,9 +4727,9 @@ export interface paths {
* Remove a security manager team
* @description Removes the security manager role from a team 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) team from an organization."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * GitHub Apps must have the `administration` organization read-write permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
readonly delete: operations["orgs/remove-security-manager-team"];
readonly options?: never;
@@ -4505,7 +4750,7 @@ export interface paths {
*
* Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * Access tokens must have the `repo` or `admin:org` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
*/
readonly get: operations["billing/get-github-actions-billing-org"];
readonly put?: never;
@@ -4529,7 +4774,7 @@ export interface paths {
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `repo` or `admin:org` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
*/
readonly get: operations["billing/get-github-packages-billing-org"];
readonly put?: never;
@@ -4553,7 +4798,7 @@ export interface paths {
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `repo` or `admin:org` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
*/
readonly get: operations["billing/get-shared-storage-billing-org"];
readonly put?: never;
@@ -4564,6 +4809,41 @@ export interface paths {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/orgs/{org}/team/{team_slug}/copilot/usage": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get a summary of Copilot usage for a team
+ * @description **Note**: This endpoint is in beta and is subject to change.
+ *
+ * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
+ * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
+ * See the response schema tab for detailed metrics definitions.
+ *
+ * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,
+ * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
+ * they must have telemetry enabled in their IDE.
+ *
+ * **Note**: This endpoint will only return results for a given day if the team had five or more members on that day.
+ *
+ * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team,
+ * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint.
+ */
+ readonly get: operations["copilot/usage-metrics-for-team"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/orgs/{org}/teams": {
readonly parameters: {
readonly query?: never;
@@ -4635,19 +4915,23 @@ export interface paths {
};
/**
* List discussions
- * @description List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description List all discussions on a team's page.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/list-discussions-in-org"];
readonly put?: never;
/**
* Create a discussion
- * @description Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Creates a new discussion post on a team's page.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["teams/create-discussion-in-org"];
readonly delete?: never;
@@ -4665,27 +4949,33 @@ export interface paths {
};
/**
* Get a discussion
- * @description Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Get a specific discussion on a team's page.
*
* **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}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/get-discussion-in-org"];
readonly put?: never;
readonly post?: never;
/**
* Delete a discussion
- * @description Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Delete a discussion from a team's page.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly delete: operations["teams/delete-discussion-in-org"];
readonly options?: never;
readonly head?: never;
/**
* Update a discussion
- * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly patch: operations["teams/update-discussion-in-org"];
readonly trace?: never;
@@ -4699,19 +4989,23 @@ export interface paths {
};
/**
* List discussion comments
- * @description List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description List all comments on a team discussion.
*
* **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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/list-discussion-comments-in-org"];
readonly put?: never;
/**
* Create a discussion comment
- * @description Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Creates a new comment on a team discussion.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
*
* **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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["teams/create-discussion-comment-in-org"];
readonly delete?: never;
@@ -4729,27 +5023,33 @@ export interface paths {
};
/**
* Get a discussion comment
- * @description Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Get a specific comment on a team discussion.
*
* **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}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/get-discussion-comment-in-org"];
readonly put?: never;
readonly post?: never;
/**
* Delete a discussion comment
- * @description Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Deletes a comment on a team discussion.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly delete: operations["teams/delete-discussion-comment-in-org"];
readonly options?: never;
readonly head?: never;
/**
* Update a discussion comment
- * @description Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Edits the body text of a discussion comment.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly patch: operations["teams/update-discussion-comment-in-org"];
readonly trace?: never;
@@ -4763,17 +5063,23 @@ export interface paths {
};
/**
* List reactions for a team discussion comment
- * @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/).
+ * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
*
* **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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["reactions/list-for-team-discussion-comment-in-org"];
readonly put?: never;
/**
* Create reaction for a 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.
+ * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * 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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["reactions/create-for-team-discussion-comment-in-org"];
readonly delete?: never;
@@ -4796,7 +5102,9 @@ 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/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 a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly delete: operations["reactions/delete-for-team-discussion-comment"];
readonly options?: never;
@@ -4813,17 +5121,23 @@ export interface paths {
};
/**
* List reactions for a team discussion
- * @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/).
+ * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
*
* **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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["reactions/list-for-team-discussion-in-org"];
readonly put?: never;
/**
* Create reaction for a 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.
+ * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
+ *
+ * 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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["reactions/create-for-team-discussion-in-org"];
readonly delete?: never;
@@ -4846,7 +5160,9 @@ 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/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 a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly delete: operations["reactions/delete-for-team-discussion"];
readonly options?: never;
@@ -5044,14 +5360,14 @@ export interface paths {
*
* If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.
*
- * If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status.
+ * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
*/
readonly get: operations["teams/check-permissions-for-repo-in-org"];
/**
* Add or update team repository permissions
- * @description 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. 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)."
+ * @description 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. 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
*
@@ -5104,14 +5420,11 @@ export interface paths {
readonly put?: never;
/**
* Enable or disable a security feature for an organization
- * @description Enables or disables the specified security feature for all eligible repositories in an organization.
- *
- * To use this endpoint, you must be an organization owner or be member of a team with the security manager role.
- * A token with the 'write:org' scope is also required.
+ * @description Enables or disables the specified security feature for all eligible repositories in 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)."
*
- * GitHub Apps must have the `organization_administration:write` permission to use this endpoint.
+ * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
*
- * 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)."
+ * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
*/
readonly post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"];
readonly delete?: never;
@@ -5354,7 +5667,7 @@ export interface paths {
*
* 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 `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/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)."
@@ -5392,10 +5705,12 @@ export interface paths {
readonly post?: never;
/**
* Delete a repository
- * @description Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.
+ * @description Deleting a repository requires admin access.
*
* If an organization owner has configured the organization to prevent members from deleting organization-owned
* repositories, you will get a `403 Forbidden` response.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.
*/
readonly delete: operations["repos/delete"];
readonly options?: never;
@@ -5416,7 +5731,11 @@ export interface paths {
};
/**
* List artifacts for a repository
- * @description Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Lists all artifacts for a repository.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/list-artifacts-for-repo"];
readonly put?: never;
@@ -5436,14 +5755,19 @@ export interface paths {
};
/**
* Get an artifact
- * @description Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Gets a specific artifact for a workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-artifact"];
readonly put?: never;
readonly post?: never;
/**
* Delete an artifact
- * @description Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * @description Deletes an artifact for a workflow run.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-artifact"];
readonly options?: never;
@@ -5463,8 +5787,7 @@ export interface paths {
* @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in
* the response header to find the URL for the download. The `:archive_format` must be `zip`.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/download-artifact"];
readonly put?: never;
@@ -5486,7 +5809,10 @@ export interface paths {
* Get GitHub Actions cache usage for a repository
* @description Gets GitHub Actions cache usage for a repository.
* The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-actions-cache-usage"];
readonly put?: never;
@@ -5507,8 +5833,8 @@ export interface paths {
/**
* List GitHub Actions caches for a repository
* @description Lists the GitHub Actions caches for a repository.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions:read` permission to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-actions-cache-list"];
readonly put?: never;
@@ -5517,9 +5843,7 @@ export interface paths {
* Delete GitHub Actions caches for a repository (using a cache key)
* @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- *
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-actions-cache-by-key"];
readonly options?: never;
@@ -5541,9 +5865,7 @@ export interface paths {
* Delete a GitHub Actions cache for a repository (using a cache ID)
* @description Deletes a GitHub Actions cache for a repository, using a cache ID.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- *
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-actions-cache-by-id"];
readonly options?: never;
@@ -5560,7 +5882,11 @@ export interface paths {
};
/**
* Get a job for a workflow run
- * @description Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Gets a specific job in a workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-job-for-workflow-run"];
readonly put?: never;
@@ -5581,9 +5907,11 @@ export interface paths {
/**
* Download job logs for a workflow run
* @description Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
- * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can
- * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must
- * have the `actions:read` permission to use this endpoint.
+ * for `Location:` in the response header to find the URL for the download.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/download-job-logs-for-workflow-run"];
readonly put?: never;
@@ -5607,8 +5935,7 @@ export interface paths {
* Re-run a job from a workflow run
* @description Re-run a job and its dependent jobs in a workflow run.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/re-run-job-for-workflow-run"];
readonly delete?: never;
@@ -5627,15 +5954,15 @@ export interface paths {
/**
* Get the customization template for an OIDC subject claim for a repository
* @description Gets the customization template for an OpenID Connect (OIDC) subject claim.
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-custom-oidc-sub-claim-for-repo"];
/**
* Set the customization template for an OIDC subject claim for a repository
* @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/set-custom-oidc-sub-claim-for-repo"];
readonly post?: never;
@@ -5657,9 +5984,9 @@ export interface paths {
* @description Lists all organization secrets shared with a repository without revealing their encrypted
* values.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-repo-organization-secrets"];
readonly put?: never;
@@ -5679,11 +6006,11 @@ export interface paths {
};
/**
* List repository organization variables
- * @description Lists all organiation variables shared with a repository.
+ * @description Lists all organization variables shared with a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-repo-organization-variables"];
readonly put?: never;
@@ -5705,14 +6032,14 @@ export interface paths {
* Get GitHub Actions permissions for a repository
* @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-github-actions-permissions-repository"];
/**
* Set GitHub Actions permissions for a repository
* @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/set-github-actions-permissions-repository"];
readonly post?: never;
@@ -5735,8 +6062,7 @@ export interface paths {
* This endpoint only applies to private repositories.
* For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
- * repository `administration` permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-workflow-access-to-repository"];
/**
@@ -5745,8 +6071,7 @@ export interface paths {
* This endpoint only applies to private repositories.
* For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)".
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
- * repository `administration` permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/set-workflow-access-to-repository"];
readonly post?: never;
@@ -5767,14 +6092,14 @@ export interface paths {
* Get allowed actions and reusable workflows for a repository
* @description Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-allowed-actions-repository"];
/**
* Set allowed actions and reusable workflows for a repository
* @description Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/set-allowed-actions-repository"];
readonly post?: never;
@@ -5797,7 +6122,7 @@ export interface paths {
* as well as if GitHub Actions can submit approving pull request reviews.
* For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-github-actions-default-workflow-permissions-repository"];
/**
@@ -5806,7 +6131,7 @@ export interface paths {
* can submit approving pull request reviews.
* For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/set-github-actions-default-workflow-permissions-repository"];
readonly post?: never;
@@ -5827,9 +6152,9 @@ export interface paths {
* List self-hosted runners for a repository
* @description Lists all self-hosted runners configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-self-hosted-runners-for-repo"];
readonly put?: never;
@@ -5851,9 +6176,9 @@ export interface paths {
* List runner applications for a repository
* @description Lists binaries for the runner application that you can download and run.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-runner-applications-for-repo"];
readonly put?: never;
@@ -5877,9 +6202,9 @@ export interface paths {
* Create configuration for a just-in-time runner for a repository
* @description Generates a configuration that can be passed to the runner application at startup.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * The authenticated user must have admin access to the repository.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.
*/
readonly post: operations["actions/generate-runner-jitconfig-for-repo"];
readonly delete?: never;
@@ -5899,19 +6224,17 @@ export interface paths {
readonly put?: never;
/**
* Create a registration token for a repository
- * @description Returns a token that you can pass to the `config` script. The token
- * expires after one hour.
+ * @description Returns a token that you can pass to the `config` script. The token expires after one hour.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
*
- * Example using registration token:
+ * ```
+ * ./config.sh --url https://github.com/octo-org --token TOKEN
+ * ```
*
- * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided
- * by this endpoint.
+ * Authenticated users must have admin access to the repository to use this endpoint.
*
- * ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-registration-token-for-repo"];
readonly delete?: never;
@@ -5931,19 +6254,17 @@ export interface paths {
readonly put?: never;
/**
* Create a remove token for a repository
- * @description Returns a token that you can pass to remove a self-hosted runner from
- * a repository. The token expires after one hour.
+ * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:
*
- * Example using remove token:
+ * ```
+ * ./config.sh remove --token TOKEN
+ * ```
*
- * To remove your self-hosted runner from a repository, replace TOKEN with
- * the remove token provided by this endpoint.
+ * Authenticated users must have admin access to the repository to use this endpoint.
*
- * ```config.sh remove --token TOKEN```
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-remove-token-for-repo"];
readonly delete?: never;
@@ -5963,9 +6284,9 @@ export interface paths {
* Get a self-hosted runner for a repository
* @description Gets a specific self-hosted runner configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-self-hosted-runner-for-repo"];
readonly put?: never;
@@ -5974,9 +6295,9 @@ export interface paths {
* Delete a self-hosted runner from a repository
* @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-self-hosted-runner-from-repo"];
readonly options?: never;
@@ -5995,9 +6316,9 @@ export interface paths {
* List labels for a self-hosted runner for a repository
* @description Lists all labels for a self-hosted runner configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-labels-for-self-hosted-runner-for-repo"];
/**
@@ -6005,18 +6326,18 @@ export interface paths {
* @description Remove all previous custom labels and set the new custom labels for a specific
* self-hosted runner configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"];
/**
* Add custom labels to a self-hosted runner for a repository
- * @description Add custom labels to a self-hosted runner configured in a repository.
+ * @description Adds custom labels to a self-hosted runner configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"];
/**
@@ -6024,9 +6345,9 @@ export interface paths {
* @description Remove all custom labels from a self-hosted runner configured in a
* repository. Returns the remaining read-only labels from the runner.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"];
readonly options?: never;
@@ -6052,9 +6373,9 @@ export interface paths {
* This endpoint returns a `404 Not Found` status if the custom label is not
* present on the runner.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
- * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"];
readonly options?: never;
@@ -6071,9 +6392,13 @@ export interface paths {
};
/**
* List workflow runs for a repository
- * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
+ * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ *
+ * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.
*/
readonly get: operations["actions/list-workflow-runs-for-repo"];
readonly put?: never;
@@ -6093,16 +6418,22 @@ export interface paths {
};
/**
* Get a workflow run
- * @description Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Gets a specific workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/get-workflow-run"];
readonly put?: never;
readonly post?: never;
/**
* Delete a workflow run
- * @description Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is
- * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use
- * this endpoint.
+ * @description Deletes a specific workflow run.
+ *
+ * Anyone with write access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-workflow-run"];
readonly options?: never;
@@ -6119,7 +6450,9 @@ export interface paths {
};
/**
* Get the review history for a workflow run
- * @description Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/get-reviews-for-run"];
readonly put?: never;
@@ -6143,7 +6476,7 @@ export interface paths {
* Approve a workflow run for a fork pull request
* @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/approve-workflow-run"];
readonly delete?: never;
@@ -6161,7 +6494,11 @@ export interface paths {
};
/**
* List workflow run artifacts
- * @description Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Lists artifacts for a workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/list-workflow-run-artifacts"];
readonly put?: never;
@@ -6181,10 +6518,11 @@ export interface paths {
};
/**
* Get a workflow run attempt
- * @description Gets a specific workflow run attempt. Anyone with read access to the repository
- * can use this endpoint. If the repository is private you must use an access token
- * with the `repo` scope. GitHub Apps must have the `actions:read` permission to
- * use this endpoint.
+ * @description Gets a specific workflow run attempt.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/get-workflow-run-attempt"];
readonly put?: never;
@@ -6204,7 +6542,12 @@ export interface paths {
};
/**
* List jobs for a workflow run attempt
- * @description Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
+ * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information
+ * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/list-jobs-for-workflow-run-attempt"];
readonly put?: never;
@@ -6225,9 +6568,11 @@ export interface paths {
/**
* Download workflow run attempt logs
* @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
- * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to
- * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
- * GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * 1 minute. Look for `Location:` in the response header to find the URL for the download.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/download-workflow-run-attempt-logs"];
readonly put?: never;
@@ -6251,8 +6596,7 @@ export interface paths {
* Cancel a workflow run
* @description Cancels a workflow run using its `id`.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/cancel-workflow-run"];
readonly delete?: never;
@@ -6277,8 +6621,7 @@ export interface paths {
* **Note:** GitHub Apps can only review their own custom deployment protection rules.
* To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).
*
- * If the repository is private, you must use an access token with the `repo` scope.
- * GitHub Apps must have read and write permission for **Deployments** to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly post: operations["actions/review-custom-gates-for-run"];
readonly delete?: never;
@@ -6301,8 +6644,7 @@ export interface paths {
* @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
* You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/force-cancel-workflow-run"];
readonly delete?: never;
@@ -6320,7 +6662,12 @@ export interface paths {
};
/**
* List jobs for a workflow run
- * @description Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
+ * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information
+ * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/list-jobs-for-workflow-run"];
readonly put?: never;
@@ -6341,16 +6688,20 @@ export interface paths {
/**
* Download workflow run logs
* @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
- * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use
- * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have
- * the `actions:read` permission to use this endpoint.
+ * `Location:` in the response header to find the URL for the download.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/download-workflow-run-logs"];
readonly put?: never;
readonly post?: never;
/**
* Delete workflow run logs
- * @description Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * @description Deletes all logs for a workflow run.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-workflow-run-logs"];
readonly options?: never;
@@ -6369,7 +6720,9 @@ export interface paths {
* Get pending deployments for a workflow run
* @description Get all deployment environments for a workflow run that are waiting for protection rules to pass.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-pending-deployments-for-run"];
readonly put?: never;
@@ -6377,7 +6730,9 @@ export interface paths {
* Review pending deployments for a workflow run
* @description Approve or reject pending deployments that are waiting on approval by a required reviewer.
*
- * Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.
+ * Required reviewers with read access to the repository contents and deployments can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/review-pending-deployments-for-run"];
readonly delete?: never;
@@ -6397,7 +6752,9 @@ export interface paths {
readonly put?: never;
/**
* Re-run a workflow
- * @description Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * @description Re-runs your workflow run using its `id`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/re-run-workflow"];
readonly delete?: never;
@@ -6417,7 +6774,9 @@ export interface paths {
readonly put?: never;
/**
* Re-run failed jobs from a workflow run
- * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint.
+ * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/re-run-workflow-failed-jobs"];
readonly delete?: never;
@@ -6437,7 +6796,9 @@ export interface paths {
* Get workflow run usage
* @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/get-workflow-run-usage"];
readonly put?: never;
@@ -6460,9 +6821,9 @@ export interface paths {
* @description Lists all secrets available in a repository without revealing their encrypted
* values.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-repo-secrets"];
readonly put?: never;
@@ -6486,9 +6847,8 @@ export interface paths {
* encrypt a secret before you can create or update secrets.
*
* Anyone with read access to the repository can use this endpoint.
- * If the repository is private you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-repo-public-key"];
readonly put?: never;
@@ -6510,9 +6870,9 @@ export interface paths {
* Get a repository secret
* @description Gets a single repository secret without revealing its encrypted value.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ * The authenticated user must have collaborator access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-repo-secret"];
/**
@@ -6520,9 +6880,9 @@ export interface paths {
* @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/create-or-update-repo-secret"];
readonly post?: never;
@@ -6530,9 +6890,9 @@ export interface paths {
* Delete a repository secret
* @description Deletes a secret in a repository using the secret name.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-repo-secret"];
readonly options?: never;
@@ -6550,9 +6910,10 @@ export interface paths {
/**
* List repository variables
* @description Lists all repository variables.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
+ *
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/list-repo-variables"];
readonly put?: never;
@@ -6560,9 +6921,9 @@ export interface paths {
* Create a repository variable
* @description Creates a repository variable that you can reference in a GitHub Actions workflow.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-repo-variable"];
readonly delete?: never;
@@ -6582,9 +6943,9 @@ export interface paths {
* Get a repository variable
* @description Gets a specific variable in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ * The authenticated user must have collaborator access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["actions/get-repo-variable"];
readonly put?: never;
@@ -6593,9 +6954,9 @@ export interface paths {
* Delete a repository variable
* @description Deletes a repository variable using the variable name.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["actions/delete-repo-variable"];
readonly options?: never;
@@ -6604,9 +6965,9 @@ export interface paths {
* Update a repository variable
* @description Updates a repository variable that you can reference in a GitHub Actions workflow.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly patch: operations["actions/update-repo-variable"];
readonly trace?: never;
@@ -6620,7 +6981,11 @@ export interface paths {
};
/**
* List repository workflows
- * @description Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Lists the workflows in a repository.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/list-repo-workflows"];
readonly put?: never;
@@ -6640,7 +7005,12 @@ export interface paths {
};
/**
* Get a workflow
- * @description Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * @description Gets a specific workflow. You can replace `workflow_id` with the workflow
+ * file name. For example, you could use `main.yaml`.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/get-workflow"];
readonly put?: never;
@@ -6663,7 +7033,7 @@ export interface paths {
* Disable a workflow
* @description Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/disable-workflow"];
readonly post?: never;
@@ -6688,7 +7058,7 @@ export interface paths {
*
* You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)."
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["actions/create-workflow-dispatch"];
readonly delete?: never;
@@ -6709,7 +7079,7 @@ export interface paths {
* Enable a workflow
* @description Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["actions/enable-workflow"];
readonly post?: never;
@@ -6728,9 +7098,11 @@ export interface paths {
};
/**
* List workflow runs for a workflow
- * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
+ * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
+ * Anyone with read access to the repository can use this endpoint
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/list-workflow-runs"];
readonly put?: never;
@@ -6752,7 +7124,11 @@ export interface paths {
* Get workflow usage
* @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["actions/get-workflow-usage"];
readonly put?: never;
@@ -6838,8 +7214,8 @@ export interface paths {
readonly cookie?: never;
};
/**
- * List all autolinks of a repository
- * @description This returns a list of autolinks configured for the given repository.
+ * Get all autolinks of a repository
+ * @description Gets all autolinks that are configured for a repository.
*
* Information about autolinks are only available to repository administrators.
*/
@@ -7183,28 +7559,28 @@ export interface paths {
* Get apps with access to the protected branch
* @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
+ * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
readonly get: operations["repos/get-apps-with-access-to-protected-branch"];
/**
* Set app access restrictions
* @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
+ * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
readonly put: operations["repos/set-app-access-restrictions"];
/**
* Add app access restrictions
* @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
+ * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
readonly post: operations["repos/add-app-access-restrictions"];
/**
* Remove app access restrictions
* @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
+ * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
readonly delete: operations["repos/remove-app-access-restrictions"];
readonly options?: never;
@@ -7319,17 +7695,9 @@ export interface paths {
*
* **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)".
*
- * The permissions required to use this endpoint depends on whether you are renaming the default branch.
- *
- * To rename a non-default branch:
- *
- * * Users must have push access.
- * * GitHub Apps must have the `contents:write` repository permission.
+ * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
*
- * To rename the default branch:
- *
- * * Users must have admin or owner permissions.
- * * GitHub Apps must have the `administration:write` repository permission.
+ * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.
*/
readonly post: operations["repos/rename-branch"];
readonly delete?: never;
@@ -7349,11 +7717,13 @@ export interface paths {
readonly put?: never;
/**
* Create a check run
- * @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.
+ * @description Creates a new check run for a specific commit in a repository.
*
- * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.
+ * To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
*
* In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
+ *
+ * **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.
*/
readonly post: operations["checks/create"];
readonly delete?: never;
@@ -7371,9 +7741,11 @@ export interface paths {
};
/**
* Get a check run
- * @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.
+ * @description Gets a single check run using its `id`.
*
- * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.
+ * **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.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
readonly get: operations["checks/get"];
readonly put?: never;
@@ -7383,9 +7755,11 @@ export interface paths {
readonly head?: never;
/**
* Update a check run
- * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.
+ * @description Updates a check run for a specific commit in a repository.
*
* **Note:** The endpoints to manage checks only look 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.
+ *
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
*/
readonly patch: operations["checks/update"];
readonly trace?: never;
@@ -7399,7 +7773,9 @@ export interface paths {
};
/**
* List check run annotations
- * @description Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.
+ * @description Lists annotations for a check run using the annotation `id`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
readonly get: operations["checks/list-annotations"];
readonly put?: never;
@@ -7423,9 +7799,9 @@ export interface paths {
* Rerequest a check run
* @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
*
- * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.
- *
* For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".
+ *
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
*/
readonly post: operations["checks/rerequest-run"];
readonly delete?: never;
@@ -7445,9 +7821,11 @@ export interface paths {
readonly put?: never;
/**
* 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`.
+ * @description Creates a check suite manually. 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)".
*
- * 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.
+ * **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`.
+ *
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
*/
readonly post: operations["checks/create-suite"];
readonly delete?: never;
@@ -7471,7 +7849,8 @@ export interface paths {
readonly head?: never;
/**
* Update repository preferences for check suites
- * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.
+ * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).
+ * You must have admin permissions in the repository to set preferences for check suites.
*/
readonly patch: operations["checks/set-suites-preferences"];
readonly trace?: never;
@@ -7485,9 +7864,11 @@ export interface paths {
};
/**
* Get 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`.
+ * @description Gets a single check suite using its `id`.
+ *
+ * **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`.
*
- * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
readonly get: operations["checks/get-suite"];
readonly put?: never;
@@ -7507,9 +7888,11 @@ export interface paths {
};
/**
* List check runs in a check suite
- * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.
+ * @description Lists check runs for a check suite using its `id`.
*
* **Note:** The endpoints to manage checks only look 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.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
readonly get: operations["checks/list-for-suite"];
readonly put?: never;
@@ -7533,7 +7916,7 @@ export interface paths {
* Rerequest a check suite
* @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
*
- * To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository.
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
*/
readonly post: operations["checks/rerequest-suite"];
readonly delete?: never;
@@ -7553,11 +7936,11 @@ export interface paths {
* List code scanning alerts for a repository
* @description Lists code scanning alerts.
*
- * To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope.
- *
* The response includes a `most_recent_instance` object.
* This provides details of the most recent instance of this alert
* for the default branch (or for the specified Git reference if you used `ref` in the request).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/list-alerts-for-repo"];
readonly put?: never;
@@ -7577,7 +7960,9 @@ export interface paths {
};
/**
* Get a code scanning alert
- * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only.
+ * @description Gets a single code scanning alert.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/get-alert"];
readonly put?: never;
@@ -7587,7 +7972,8 @@ export interface paths {
readonly head?: never;
/**
* Update a code scanning alert
- * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only.
+ * @description Updates the status of a single code scanning alert.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly patch: operations["code-scanning/update-alert"];
readonly trace?: never;
@@ -7602,8 +7988,8 @@ export interface paths {
/**
* List instances of a code scanning alert
* @description Lists all instances of the specified code scanning alert.
- * You must use an access token with the `security_events` scope to use this endpoint with private repos,
- * the `public_repo` scope also grants permission to read security events on public repos only.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/list-alert-instances"];
readonly put?: never;
@@ -7634,11 +8020,10 @@ export interface paths {
* For very old analyses this data is not available,
* and `0` is returned in this field.
*
- * You must use an access token with the `security_events` scope to use this endpoint with private repos,
- * the `public_repo` scope also grants permission to read security events on public repos only.
- *
* **Deprecation notice**:
* The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/list-recent-analyses"];
readonly put?: never;
@@ -7659,8 +8044,6 @@ export interface paths {
/**
* Get a code scanning analysis for a repository
* @description Gets a specified code scanning analysis for a repository.
- * You must use an access token with the `security_events` scope to use this endpoint with private repos,
- * the `public_repo` scope also grants permission to read security events on public repos only.
*
* The default JSON response contains fields that describe the analysis.
* This includes the Git reference and commit SHA to which the analysis relates,
@@ -7672,20 +8055,18 @@ export interface paths {
* For very old analyses this data is not available,
* and `0` is returned in this field.
*
- * If you use the Accept header `application/sarif+json`,
- * the response contains the analysis data that was uploaded.
- * This is formatted as
- * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/get-analysis"];
readonly put?: never;
readonly post?: never;
/**
* Delete a code scanning analysis from a repository
- * @description Deletes a specified code scanning analysis from a repository. For
- * private repositories, you must use an access token with the `repo` scope. For public repositories,
- * you must use an access token with `public_repo` scope.
- * GitHub Apps must have the `security_events` write permission to use this endpoint.
+ * @description Deletes a specified code scanning analysis from a repository.
*
* You can delete one analysis at a time.
* To delete a series of analyses, start with the most recent analysis and work backwards.
@@ -7747,6 +8128,8 @@ export interface paths {
* * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.
*
* The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly delete: operations["code-scanning/delete-analysis"];
readonly options?: never;
@@ -7765,8 +8148,7 @@ export interface paths {
* List CodeQL databases for a repository
* @description Lists the CodeQL databases that are available in a repository.
*
- * For private repositories, you must use an access token with the `security_events` scope.
- * For public repositories, you can use tokens with the `security_events` or `public_repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/list-codeql-databases"];
readonly put?: never;
@@ -7794,8 +8176,7 @@ export interface paths {
* your HTTP client is configured to follow redirects or use the `Location` header
* to make a second request to get the redirect URL.
*
- * For private repositories, you must use an access token with the `security_events` scope.
- * For public repositories, you can use tokens with the `security_events` or `public_repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/get-codeql-database"];
readonly put?: never;
@@ -7816,8 +8197,8 @@ export interface paths {
/**
* Get a code scanning default setup configuration
* @description Gets a code scanning default setup configuration.
- * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo`
- * scope for public repos.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/get-default-setup"];
readonly put?: never;
@@ -7828,8 +8209,8 @@ export interface paths {
/**
* Update a code scanning default setup configuration
* @description Updates a code scanning default setup configuration.
- * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo`
- * scope for public repos.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly patch: operations["code-scanning/update-default-setup"];
readonly trace?: never;
@@ -7845,7 +8226,7 @@ export interface paths {
readonly put?: never;
/**
* 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. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)."
+ * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. 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)."
@@ -7856,7 +8237,7 @@ export interface paths {
* ```
* gzip -c analysis-data.sarif | base64 -w0
* ```
- *
+ *
* 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)."
*
@@ -7875,6 +8256,8 @@ export interface paths {
* The `202 Accepted` response includes an `id` value.
* You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.
* For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly post: operations["code-scanning/upload-sarif"];
readonly delete?: never;
@@ -7892,7 +8275,8 @@ export interface paths {
};
/**
* Get information about a SARIF upload
- * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only.
+ * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)."
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
readonly get: operations["code-scanning/get-sarif"];
readonly put?: never;
@@ -7938,9 +8322,7 @@ export interface paths {
* List codespaces in a repository for the authenticated user
* @description Lists the codespaces associated to a specified repository and the authenticated user.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-in-repository-for-authenticated-user"];
readonly put?: never;
@@ -7948,9 +8330,7 @@ export interface paths {
* Create a codespace in a repository
* @description Creates a codespace owned by the authenticated user in the specified repository.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/create-with-repo-for-authenticated-user"];
readonly delete?: never;
@@ -7971,9 +8351,7 @@ export interface paths {
* @description Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files
* specify launchpoint configurations for codespaces created within the repository.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-devcontainers-in-repository-for-authenticated-user"];
readonly put?: never;
@@ -7995,9 +8373,7 @@ export interface paths {
* List available machine types for a repository
* @description List the machine types available for a given repository based on its configuration.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/repo-machines-for-authenticated-user"];
readonly put?: never;
@@ -8019,9 +8395,7 @@ export interface paths {
* Get default attributes for a codespace
* @description Gets the default attributes for codespaces created by the user with the repository.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"];
readonly put?: never;
@@ -8043,9 +8417,7 @@ export interface paths {
* Check if permissions defined by a devcontainer have been accepted by the authenticated user
* @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/check-permissions-for-devcontainer"];
readonly put?: never;
@@ -8065,7 +8437,10 @@ export interface paths {
};
/**
* List repository secrets
- * @description Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
+ * @description Lists all development environment secrets available in a repository without revealing their encrypted
+ * values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-repo-secrets"];
readonly put?: never;
@@ -8085,7 +8460,12 @@ export interface paths {
};
/**
* Get a repository public key
- * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-repo-public-key"];
readonly put?: never;
@@ -8105,7 +8485,9 @@ export interface paths {
};
/**
* Get a repository secret
- * @description Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
+ * @description Gets a single repository development environment secret without revealing its encrypted value.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-repo-secret"];
/**
@@ -8113,15 +8495,15 @@ export interface paths {
* @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access
- * token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets`
- * repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["codespaces/create-or-update-repo-secret"];
readonly post?: never;
/**
* Delete a repository secret
- * @description Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
+ * @description Deletes a development environment secret in a repository using the secret name.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["codespaces/delete-repo-secret"];
readonly options?: never;
@@ -8143,9 +8525,9 @@ export interface paths {
*
* Team members will include the members of child teams.
*
- * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this
- * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this
- * endpoint.
+ * The authenticated user must have push access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.
*/
readonly get: operations["repos/list-collaborators"];
readonly put?: never;
@@ -8169,9 +8551,9 @@ export interface paths {
*
* Team members will include the members of child teams.
*
- * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this
- * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this
- * endpoint.
+ * The authenticated user must have push access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.
*/
readonly get: operations["repos/check-collaborator"];
/**
@@ -8186,7 +8568,7 @@ export interface paths {
* Cannot assign {member} permission of {role name}
* ```
*
- * 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)."
+ * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*
* 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).
*
@@ -8265,9 +8647,14 @@ export interface paths {
};
/**
* List commit comments for a repository
- * @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/).
+ * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
*
- * Comments are ordered by ascending ID.
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["repos/list-commit-comments-for-repo"];
readonly put?: never;
@@ -8285,7 +8672,17 @@ export interface paths {
readonly path?: never;
readonly cookie?: never;
};
- /** Get a commit comment */
+ /**
+ * Get a commit comment
+ * @description Gets a specified commit comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
readonly get: operations["repos/get-commit-comment"];
readonly put?: never;
readonly post?: never;
@@ -8293,7 +8690,17 @@ export interface paths {
readonly delete: operations["repos/delete-commit-comment"];
readonly options?: never;
readonly head?: never;
- /** Update a commit comment */
+ /**
+ * Update a commit comment
+ * @description Updates the contents of a specified commit comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
readonly patch: operations["repos/update-commit-comment"];
readonly trace?: never;
};
@@ -8421,7 +8828,14 @@ export interface paths {
};
/**
* List commit comments
- * @description Use the `:commit_sha` to specify the commit that will have its comments listed.
+ * @description Lists the comments for a specified commit.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["repos/list-comments-for-commit"];
readonly put?: never;
@@ -8430,6 +8844,13 @@ export interface paths {
* @description Create a comment for a commit using its `:commit_sha`.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["repos/create-commit-comment"];
readonly delete?: never;
@@ -8471,11 +8892,13 @@ export interface paths {
* Get a commit
* @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
*
- * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
+ * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
*
- * You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types.
*
- * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
+ * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
+ * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.
+ * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
*
* **Signature verification object**
*
@@ -8524,11 +8947,13 @@ export interface paths {
};
/**
* List check runs for a Git reference
- * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.
+ * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.
*
* **Note:** The endpoints to manage checks only look 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.
*
* If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
readonly get: operations["checks/list-for-ref"];
readonly put?: never;
@@ -8548,9 +8973,11 @@ export interface paths {
};
/**
* List check suites for a Git reference
- * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.
+ * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.
*
* **Note:** The endpoints to manage checks only look 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`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
readonly get: operations["checks/list-suites-for-ref"];
readonly put?: never;
@@ -8649,9 +9076,14 @@ export interface paths {
};
/**
* Compare two commits
- * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)."
+ * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)."
+ *
+ * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
*
- * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
+ * - **`application/vnd.github.diff`**: Returns the diff of the commit.
+ * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.
*
* The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.
*
@@ -8713,50 +9145,40 @@ export interface paths {
};
/**
* Get repository content
- * @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.
+ * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.
+ * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
+ * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.
+ *
+ * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule".
*
- * 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/overview/media-types) to ensure the content is returned in a consistent
- * object format.
+ * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.
+ *
+ * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values.
*
* **Notes**:
- * * 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.
- * Size limits:
- * If the requested file's size is:
- * * 1 MB or smaller: All features of this endpoint are supported.
- * * Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type.
- * * Greater than 100 MB: This endpoint is not supported.
- *
- * If the content is a directory:
- * The response will be an array of objects, one object for each item in the directory.
- * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value
- * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).
- * In the next major version of the API, the type will be returned as "submodule".
- *
- * If the content is a symlink:
- * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the
- * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object
- * describing the symlink itself.
- *
- * If the content is a submodule:
- * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific
- * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out
- * the submodule at that specific commit.
- *
- * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the
- * github.com URLs (`html_url` and `_links["html"]`) will have null values.
+ *
+ * - 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.
+ * - If the requested file's size is:
+ * - 1 MB or smaller: All features of this endpoint are supported.
+ * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty
+ * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type.
+ * - Greater than 100 MB: This endpoint is not supported.
*/
readonly get: operations["repos/get-content"];
/**
* 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 `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope.
+ * @description Creates a new file or replaces an existing file in a repository.
*
* **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.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.
*/
readonly put: operations["repos/create-or-update-file-contents"];
readonly post?: never;
@@ -8809,9 +9231,7 @@ export interface paths {
};
/**
* List Dependabot alerts for a repository
- * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories.
- * You can also use tokens with the `public_repo` scope for public repositories only.
- * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
+ * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["dependabot/list-alerts-for-repo"];
readonly put?: never;
@@ -8831,9 +9251,7 @@ export interface paths {
};
/**
* Get a Dependabot alert
- * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories.
- * You can also use tokens with the `public_repo` scope for public repositories only.
- * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
+ * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["dependabot/get-alert"];
readonly put?: never;
@@ -8843,11 +9261,9 @@ export interface paths {
readonly head?: never;
/**
* Update a Dependabot alert
- * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories.
- * You can also use tokens with the `public_repo` scope for public repositories only.
- * GitHub Apps must have **Dependabot alerts** write permission to use this endpoint.
+ * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
*
- * To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly patch: operations["dependabot/update-alert"];
readonly trace?: never;
@@ -8861,7 +9277,10 @@ export interface paths {
};
/**
* List repository secrets
- * @description Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
+ * @description Lists all secrets available in a repository without revealing their encrypted
+ * values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["dependabot/list-repo-secrets"];
readonly put?: never;
@@ -8881,7 +9300,11 @@ export interface paths {
};
/**
* Get a repository public key
- * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets. Anyone with read access
+ * to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private.
*/
readonly get: operations["dependabot/get-repo-public-key"];
readonly put?: never;
@@ -8901,7 +9324,9 @@ export interface paths {
};
/**
* Get a repository secret
- * @description Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
+ * @description Gets a single repository secret without revealing its encrypted value.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["dependabot/get-repo-secret"];
/**
@@ -8909,15 +9334,15 @@ export interface paths {
* @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access
- * token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository
- * permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["dependabot/create-or-update-repo-secret"];
readonly post?: never;
/**
* Delete a repository secret
- * @description Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
+ * @description Deletes a secret in a repository using the secret name.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["dependabot/delete-repo-secret"];
readonly options?: never;
@@ -8976,7 +9401,11 @@ export interface paths {
readonly put?: never;
/**
* Create a snapshot of dependencies for a repository
- * @description Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to.
+ * @description Create a new snapshot of a repository's dependencies.
+ *
+ * The authenticated user must have access to the repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["dependency-graph/create-repository-snapshot"];
readonly delete?: never;
@@ -9026,8 +9455,6 @@ export interface paths {
* be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an
* application with debugging enabled.
*
- * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref.
- *
* Merged branch response:
*
* You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
@@ -9048,6 +9475,8 @@ export interface paths {
*
* This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`
* status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.
*/
readonly post: operations["repos/create-deployment"];
readonly delete?: never;
@@ -9069,7 +9498,7 @@ export interface paths {
readonly post?: never;
/**
* Delete a deployment
- * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment.
+ * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.
*
* To set a deployment as inactive, you must:
*
@@ -9077,6 +9506,8 @@ export interface paths {
* * Mark the active deployment as inactive by adding any non-successful deployment status.
*
* For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.
*/
readonly delete: operations["repos/delete-deployment"];
readonly options?: never;
@@ -9101,7 +9532,7 @@ export interface paths {
* Create a deployment status
* @description Users with `push` access can create deployment statuses for a given deployment.
*
- * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint.
*/
readonly post: operations["repos/create-deployment-status"];
readonly delete?: never;
@@ -9145,12 +9576,9 @@ export interface paths {
*
* The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.
*
- * This endpoint requires write access to the repository by providing either:
- *
- * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation.
- * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.
- *
* This input example shows how you can use the `client_payload` as a test to debug your workflow.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["repos/create-dispatch-event"];
readonly delete?: never;
@@ -9170,7 +9598,9 @@ export interface paths {
* List environments
* @description Lists the environments for a repository.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/get-all-environments"];
readonly put?: never;
@@ -9192,9 +9622,9 @@ export interface paths {
* Get an environment
* @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)."
*
- * Anyone with read access to the repository can use this endpoint. If the
- * repository is private, you must use an access token with the `repo` scope. GitHub
- * Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/get-environment"];
/**
@@ -9205,13 +9635,13 @@ export interface paths {
*
* **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.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["repos/create-or-update-environment"];
readonly post?: never;
/**
* Delete an environment
- * @description You must authenticate using an access token with the repo scope to use this endpoint.
+ * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["repos/delete-an-environment"];
readonly options?: never;
@@ -9230,7 +9660,9 @@ export interface paths {
* List deployment branch policies
* @description Lists the deployment branch policies for an environment.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/list-deployment-branch-policies"];
readonly put?: never;
@@ -9238,7 +9670,7 @@ export interface paths {
* Create a deployment branch policy
* @description Creates a deployment branch or tag policy for an environment.
*
- * 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.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["repos/create-deployment-branch-policy"];
readonly delete?: never;
@@ -9258,14 +9690,16 @@ export interface paths {
* Get a deployment branch policy
* @description Gets a deployment branch or tag policy for an environment.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/get-deployment-branch-policy"];
/**
* Update a deployment branch policy
* @description Updates a deployment branch or tag policy for an environment.
*
- * 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.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["repos/update-deployment-branch-policy"];
readonly post?: never;
@@ -9273,7 +9707,7 @@ export interface paths {
* Delete a deployment branch policy
* @description Deletes a deployment branch or tag policy for an environment.
*
- * 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.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["repos/delete-deployment-branch-policy"];
readonly options?: never;
@@ -9290,9 +9724,11 @@ export interface paths {
};
/**
* Get all deployment protection rules for an environment
- * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+ * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
*
* For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/get-all-deployment-protection-rules"];
readonly put?: never;
@@ -9300,9 +9736,11 @@ export interface paths {
* Create a custom deployment protection rule on an environment
* @description Enable a custom deployment protection rule for an environment.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * The authenticated user must have admin or owner permissions to the repository to use this endpoint.
*
* For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["repos/create-deployment-protection-rule"];
readonly delete?: never;
@@ -9320,11 +9758,13 @@ export interface paths {
};
/**
* List custom deployment rule integrations available for an environment
- * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint.
+ * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint.
*
- * For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+ * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
*
* For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)".
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/list-custom-deployment-rule-integrations"];
readonly put?: never;
@@ -9344,9 +9784,11 @@ export interface paths {
};
/**
* Get a custom deployment protection rule
- * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+ * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
*
* For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/get-custom-deployment-protection-rule"];
readonly put?: never;
@@ -9355,7 +9797,9 @@ export interface paths {
* Disable a custom protection rule for an environment
* @description Disables a custom deployment protection rule for an environment.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)".
+ * The authenticated user must have admin or owner permissions to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["repos/disable-deployment-protection-rule"];
readonly options?: never;
@@ -9363,6 +9807,169 @@ export interface paths {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * List environment secrets
+ * @description Lists all secrets available in an environment without revealing their
+ * encrypted values.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly get: operations["actions/list-environment-secrets"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get an environment public key
+ * @description Get the public key for an environment, which you need to encrypt environment
+ * secrets. You need to encrypt a secret before you can create or update secrets.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly get: operations["actions/get-environment-public-key"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get an environment secret
+ * @description Gets a single environment secret without revealing its encrypted value.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly get: operations["actions/get-environment-secret"];
+ /**
+ * Create or update an environment secret
+ * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly put: operations["actions/create-or-update-environment-secret"];
+ readonly post?: never;
+ /**
+ * Delete an environment secret
+ * @description Deletes a secret in an environment using the secret name.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly delete: operations["actions/delete-environment-secret"];
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/repos/{owner}/{repo}/environments/{environment_name}/variables": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * List environment variables
+ * @description Lists all environment variables.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly get: operations["actions/list-environment-variables"];
+ readonly put?: never;
+ /**
+ * Create an environment variable
+ * @description Create an environment variable that you can reference in a GitHub Actions workflow.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly post: operations["actions/create-environment-variable"];
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get an environment variable
+ * @description Gets a specific variable in an environment.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly get: operations["actions/get-environment-variable"];
+ readonly put?: never;
+ readonly post?: never;
+ /**
+ * Delete an environment variable
+ * @description Deletes an environment variable using the variable name.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly delete: operations["actions/delete-environment-variable"];
+ readonly options?: never;
+ readonly head?: never;
+ /**
+ * Update an environment variable
+ * @description Updates an environment variable that you can reference in a GitHub Actions workflow.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ readonly patch: operations["actions/update-environment-variable"];
+ readonly trace?: never;
+ };
readonly "/repos/{owner}/{repo}/events": {
readonly parameters: {
readonly query?: never;
@@ -9437,7 +10044,12 @@ export interface paths {
* Get a blob
* @description The `content` in the response will always be Base64 encoded.
*
- * _Note_: This API supports blobs up to 100 megabytes in size.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw blob data.
+ * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.
+ *
+ * **Note** This endpoint supports blobs up to 100 megabytes in size.
*/
readonly get: operations["git/get-blob"];
readonly put?: never;
@@ -9626,11 +10238,17 @@ export interface paths {
readonly get?: never;
readonly put?: never;
readonly post?: never;
- /** Delete a reference */
+ /**
+ * Delete a reference
+ * @description Deletes the provided reference.
+ */
readonly delete: operations["git/delete-ref"];
readonly options?: never;
readonly head?: never;
- /** Update a reference */
+ /**
+ * Update a reference
+ * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
+ */
readonly patch: operations["git/update-ref"];
readonly trace?: never;
};
@@ -9840,7 +10458,7 @@ export interface paths {
* 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/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.
+ * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.
*/
readonly get: operations["repos/get-webhook-config-for-repo"];
readonly put?: never;
@@ -9852,7 +10470,7 @@ export interface paths {
* 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/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.
+ * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.
*/
readonly patch: operations["repos/update-webhook-config-for-repo"];
readonly trace?: never;
@@ -10250,6 +10868,13 @@ export interface paths {
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/list-for-repo"];
readonly put?: never;
@@ -10259,6 +10884,13 @@ export interface paths {
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
* and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["issues/create"];
readonly delete?: never;
@@ -10279,6 +10911,13 @@ export interface paths {
* @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.
*
* By default, issue comments are ordered by ascending ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/list-comments-for-repo"];
readonly put?: never;
@@ -10299,6 +10938,13 @@ export interface paths {
/**
* Get an issue comment
* @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/get-comment"];
readonly put?: never;
@@ -10313,6 +10959,13 @@ export interface paths {
/**
* Update an issue comment
* @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly patch: operations["issues/update-comment"];
readonly trace?: never;
@@ -10412,7 +11065,7 @@ export interface paths {
};
/**
* Get an issue
- * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was
+ * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was
* [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If
* the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
* returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read
@@ -10423,6 +11076,13 @@ export interface paths {
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/get"];
readonly put?: never;
@@ -10433,6 +11093,13 @@ export interface paths {
/**
* Update an issue
* @description Issue owners and users with push access can edit an issue.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly patch: operations["issues/update"];
readonly trace?: never;
@@ -10497,18 +11164,31 @@ export interface paths {
* @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
*
* Issue comments are ordered by ascending ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/list-comments"];
readonly put?: never;
/**
* Create an issue comment
- * @description
- * You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
*
* 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.
* For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
* and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["issues/create-comment"];
readonly delete?: never;
@@ -10601,7 +11281,7 @@ export interface paths {
* Lock an issue
* @description Users with push access can lock an issue or pull request's conversation.
*
- * 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)."
+ * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
readonly put: operations["issues/lock"];
readonly post?: never;
@@ -10806,7 +11486,10 @@ export interface paths {
* Get the license for a repository
* @description This method returns the contents of the repository's license file, if one is detected.
*
- * Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license.
+ * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
*/
readonly get: operations["licenses/get-for-repo"];
readonly put?: never;
@@ -10958,28 +11641,34 @@ export interface paths {
* Get a GitHub Pages site
* @description Gets information about a GitHub Pages site.
*
- * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["repos/get-pages"];
/**
* Update information about a GitHub Pages site
* @description Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
*
- * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly put: operations["repos/update-information-about-pages-site"];
/**
* Create a GitHub Pages site
* @description Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."
*
- * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly post: operations["repos/create-pages-site"];
/**
* Delete a GitHub Pages site
* @description Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
*
- * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly delete: operations["repos/delete-pages-site"];
readonly options?: never;
@@ -10998,7 +11687,7 @@ export interface paths {
* List GitHub Pages builds
* @description Lists builts of a GitHub Pages site.
*
- * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["repos/list-pages-builds"];
readonly put?: never;
@@ -11026,7 +11715,7 @@ export interface paths {
* Get latest Pages build
* @description Gets information about the single most recent build of a GitHub Pages site.
*
- * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["repos/get-latest-pages-build"];
readonly put?: never;
@@ -11048,7 +11737,7 @@ export interface paths {
* Get GitHub Pages build
* @description Gets information about a GitHub Pages build.
*
- * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["repos/get-pages-build"];
readonly put?: never;
@@ -11059,7 +11748,7 @@ export interface paths {
readonly patch?: never;
readonly trace?: never;
};
- readonly "/repos/{owner}/{repo}/pages/deployment": {
+ readonly "/repos/{owner}/{repo}/pages/deployments": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
@@ -11072,7 +11761,7 @@ export interface paths {
* Create a GitHub Pages deployment
* @description Create a GitHub Pages deployment for a repository.
*
- * Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint.
+ * The authenticated user must have write permission to the repository.
*/
readonly post: operations["repos/create-pages-deployment"];
readonly delete?: never;
@@ -11081,6 +11770,50 @@ export interface paths {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get the status of a GitHub Pages deployment
+ * @description Gets the current status of a GitHub Pages deployment.
+ *
+ * The authenticated user must have read permission for the GitHub Pages site.
+ */
+ readonly get: operations["repos/get-pages-deployment"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ readonly get?: never;
+ readonly put?: never;
+ /**
+ * Cancel a GitHub Pages deployment
+ * @description Cancels a GitHub Pages deployment.
+ *
+ * The authenticated user must have write permissions for the GitHub Pages site.
+ */
+ readonly post: operations["repos/cancel-pages-deployment"];
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/repos/{owner}/{repo}/pages/health": {
readonly parameters: {
readonly query?: never;
@@ -11094,7 +11827,9 @@ export interface paths {
*
* The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.
*
- * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions.
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["repos/get-pages-health-check"];
readonly put?: never;
@@ -11112,7 +11847,11 @@ export interface paths {
readonly path?: never;
readonly cookie?: never;
};
- readonly get?: never;
+ /**
+ * Check if private vulnerability reporting is enabled for a repository
+ * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)".
+ */
+ readonly get: operations["repos/check-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)."
@@ -11171,7 +11910,14 @@ export interface paths {
readonly delete?: never;
readonly options?: never;
readonly head?: never;
- readonly patch?: never;
+ /**
+ * Create or update custom property values for a repository
+ * @description Create new or update existing custom property values for a repository.
+ * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.
+ *
+ * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint.
+ */
+ readonly patch: operations["repos/create-or-update-custom-properties-values"];
readonly trace?: never;
};
readonly "/repos/{owner}/{repo}/pulls": {
@@ -11183,7 +11929,20 @@ export interface paths {
};
/**
* List pull requests
- * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * @description Lists pull requests in a specified repository.
+ *
+ * Draft pull requests are available in public repositories with GitHub
+ * Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing
+ * plans, and in public and private repositories with GitHub Team and GitHub Enterprise
+ * Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)
+ * in the GitHub Help documentation.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list"];
readonly put?: never;
@@ -11194,6 +11953,13 @@ export interface paths {
* To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["pulls/create"];
readonly delete?: never;
@@ -11211,7 +11977,15 @@ export interface paths {
};
/**
* List review comments in a repository
- * @description Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
+ * @description Lists review comments for all pull requests in a repository. By default,
+ * review comments are in ascending order by ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list-review-comments-for-repo"];
readonly put?: never;
@@ -11231,7 +12005,14 @@ export interface paths {
};
/**
* Get a review comment for a pull request
- * @description Provides details for a review comment.
+ * @description Provides details for a specified review comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/get-review-comment"];
readonly put?: never;
@@ -11245,7 +12026,14 @@ export interface paths {
readonly head?: never;
/**
* Update a review comment for a pull request
- * @description Enables you to edit a review comment.
+ * @description Edits the content of a specified review comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly patch: operations["pulls/update-review-comment"];
readonly trace?: never;
@@ -11320,6 +12108,14 @@ export interface paths {
* * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.
*
* Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
*/
readonly get: operations["pulls/get"];
readonly put?: never;
@@ -11332,6 +12128,13 @@ export interface paths {
* @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly patch: operations["pulls/update"];
readonly trace?: never;
@@ -11349,9 +12152,7 @@ export interface paths {
* Create a codespace from a pull request
* @description Creates a codespace owned by the authenticated user for the specified pull request.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/create-with-pr-for-authenticated-user"];
readonly delete?: never;
@@ -11369,21 +12170,35 @@ export interface paths {
};
/**
* List review comments on a pull request
- * @description Lists all review comments for a pull request. By default, review comments are in ascending order by ID.
+ * @description Lists all review comments for a specified pull request. By default, review comments
+ * are in ascending order by ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list-review-comments"];
readonly put?: never;
/**
* Create a review comment for a pull request
- * @description
- * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.
+ * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)."
*
- * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.
+ * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.
*
- * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
+ * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
* and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["pulls/create-review-comment"];
readonly delete?: never;
@@ -11407,6 +12222,13 @@ export interface paths {
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
* and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["pulls/create-reply-for-review-comment"];
readonly delete?: never;
@@ -11424,7 +12246,16 @@ export interface paths {
};
/**
* 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/commits/commits#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.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list-commits"];
readonly put?: never;
@@ -11444,7 +12275,17 @@ export interface paths {
};
/**
* List pull requests files
- * @description **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
+ * @description Lists the files in a specified pull request.
+ *
+ * **Note:** Responses include a maximum of 3000 files. The paginated response
+ * returns 30 files per page by default.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list-files"];
readonly put?: never;
@@ -11518,19 +12359,35 @@ export interface paths {
};
/**
* List reviews for a pull request
- * @description The list of reviews returns in chronological order.
+ * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list-reviews"];
readonly put?: never;
/**
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ * @description Creates a review on a specified pull request.
+ *
+ * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
*
* 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.
+ * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.
*
* The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["pulls/create-review"];
readonly delete?: never;
@@ -11549,17 +12406,38 @@ export interface paths {
/**
* Get a review for a pull request
* @description Retrieves a pull request review by its ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/get-review"];
/**
* Update a review for a pull request
- * @description Update the review summary comment with new text.
+ * @description Updates the contents of a specified review summary comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly put: operations["pulls/update-review"];
readonly post?: never;
/**
* Delete a pending review for a pull request
* @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly delete: operations["pulls/delete-pending-review"];
readonly options?: never;
@@ -11576,7 +12454,14 @@ export interface paths {
};
/**
* List comments for a pull request review
- * @description List comments for a specific pull request review.
+ * @description Lists comments for a specific pull request review.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["pulls/list-comments-for-review"];
readonly put?: never;
@@ -11597,7 +12482,18 @@ export interface paths {
readonly get?: never;
/**
* Dismiss a review for a pull request
- * @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.
+ * @description Dismisses a specified review on a pull request.
+ *
+ * **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.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly put: operations["pulls/dismiss-review"];
readonly post?: never;
@@ -11619,6 +12515,13 @@ export interface paths {
/**
* 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/reviews#create-a-review-for-a-pull-request)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly post: operations["pulls/submit-review"];
readonly delete?: never;
@@ -11658,7 +12561,10 @@ 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/overview/media-types) for retrieving the raw content or rendered HTML.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
+ * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
*/
readonly get: operations["repos/get-readme"];
readonly put?: never;
@@ -11680,7 +12586,10 @@ 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/overview/media-types) for retrieving the raw content or rendered HTML.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
+ * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
*/
readonly get: operations["repos/get-readme-in-directory"];
readonly put?: never;
@@ -11815,7 +12724,11 @@ export interface paths {
};
/**
* Get a release
- * @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia).
+ * @description Gets a public release with the specified release ID.
+ *
+ * **Note:** This returns an `upload_url` key corresponding to the endpoint
+ * for uploading release assets. This key is a hypermedia resource. For more information, see
+ * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."
*/
readonly get: operations["repos/get-release"];
readonly put?: never;
@@ -11846,7 +12759,7 @@ export interface paths {
readonly put?: never;
/**
* Upload a release asset
- * @description This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
+ * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
* the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.
*
* You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.
@@ -12046,10 +12959,10 @@ export interface paths {
/**
* List secret scanning alerts for a repository
* @description Lists secret scanning alerts for an eligible repository, from newest to oldest.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["secret-scanning/list-alerts-for-repo"];
readonly put?: never;
@@ -12070,10 +12983,10 @@ export interface paths {
/**
* Get a secret scanning alert
* @description Gets a single secret scanning alert detected in an eligible repository.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["secret-scanning/get-alert"];
readonly put?: never;
@@ -12084,10 +12997,10 @@ export interface paths {
/**
* Update a secret scanning alert
* @description Updates the status of a secret scanning alert in an eligible repository.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
*
- * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly patch: operations["secret-scanning/update-alert"];
readonly trace?: never;
@@ -12102,10 +13015,10 @@ export interface paths {
/**
* List locations for a secret scanning alert
* @description Lists all locations for a given secret scanning alert for an eligible repository.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
readonly get: operations["secret-scanning/list-locations-for-alert"];
readonly put?: never;
@@ -12126,19 +13039,20 @@ export interface paths {
/**
* List repository security advisories
* @description Lists security advisories in a repository.
- * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission
- * in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to.
*
- * You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory.
+ * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
*/
readonly get: operations["security-advisories/list-repository-advisories"];
readonly put?: never;
/**
* Create a repository security advisory
* @description Creates a new repository security advisory.
- * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.
*
- * In order to create a draft repository security advisory, you must be a security manager or administrator of that repository.
+ * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
*/
readonly post: operations["security-advisories/create-repository-advisory"];
readonly delete?: never;
@@ -12178,12 +13092,13 @@ export interface paths {
/**
* Get a repository security advisory
* @description Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
- * You can access any published security advisory on a public repository.
- * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission
- * in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to.
*
- * You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a
+ * Anyone can access any published security advisory on a public repository.
+ *
+ * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a
* collaborator on the security advisory.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
*/
readonly get: operations["security-advisories/get-repository-advisory"];
readonly put?: never;
@@ -12194,10 +13109,11 @@ export interface paths {
/**
* Update a repository security advisory
* @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
- * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.
*
- * In order to update any security advisory, you must be a security manager or administrator of that repository,
+ * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository,
* or a collaborator on the repository security advisory.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
*/
readonly patch: operations["security-advisories/update-repository-advisory"];
readonly trace?: never;
@@ -12217,9 +13133,9 @@ export interface paths {
*
* 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, the authenticated user must be a security manager or administrator of that repository.
*
- * In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
*/
readonly post: operations["security-advisories/create-repository-advisory-cve-request"];
readonly delete?: never;
@@ -12228,6 +13144,28 @@ export interface paths {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ readonly get?: never;
+ readonly put?: never;
+ /**
+ * Create a temporary private fork
+ * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.
+ *
+ * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.
+ */
+ readonly post: operations["security-advisories/create-fork"];
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/repos/{owner}/{repo}/stargazers": {
readonly parameters: {
readonly query?: never;
@@ -12239,7 +13177,9 @@ export interface paths {
* List stargazers
* @description Lists the people that have starred the repository.
*
- * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
*/
readonly get: operations["activity/list-stargazers-for-repo"];
readonly put?: never;
@@ -12259,7 +13199,12 @@ export interface paths {
};
/**
* Get the weekly commit activity
- * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
+ * @description
+ * Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
+ *
+ * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains
+ * 10,000 or more commits, a 422 status code will be returned.
+ *
*/
readonly get: operations["repos/get-code-frequency-stats"];
readonly put?: never;
@@ -12302,10 +13247,12 @@ export interface paths {
* @description
* Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:
*
- * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).
+ * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).
* * `a` - Number of additions
* * `d` - Number of deletions
* * `c` - Number of commits
+ *
+ * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.
*/
readonly get: operations["repos/get-contributors-stats"];
readonly put?: never;
@@ -12537,11 +13484,7 @@ export interface paths {
*
* For a public repository, a team is listed only if that team added the public repository explicitly.
*
- * Personal access tokens require the following scopes:
- * * `public_repo` to call this endpoint on a public repository
- * * `repo` to call this endpoint on a private repository (this scope also includes public repositories)
- *
- * This endpoint is not compatible with fine-grained personal access tokens.
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository.
*/
readonly get: operations["repos/list-teams"];
readonly put?: never;
@@ -12662,7 +13605,6 @@ export interface paths {
/**
* Transfer a repository
* @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).
- * You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account.
*/
readonly post: operations["repos/transfer"];
readonly delete?: never;
@@ -12738,12 +13680,7 @@ export interface paths {
* Create a repository using a template
* @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
*
- * **OAuth scope requirements**
- *
- * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
- *
- * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- * * `repo` scope to create a private repository
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
*/
readonly post: operations["repos/create-using-template"];
readonly delete?: never;
@@ -12776,170 +13713,6 @@ export interface paths {
readonly patch?: never;
readonly trace?: never;
};
- readonly "/repositories/{repository_id}/environments/{environment_name}/secrets": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
- };
- /**
- * List environment secrets
- * @description Lists all secrets available in an environment without revealing their
- * encrypted values.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
- */
- readonly get: operations["actions/list-environment-secrets"];
- readonly put?: never;
- readonly post?: never;
- readonly delete?: never;
- readonly options?: never;
- readonly head?: never;
- readonly patch?: never;
- readonly trace?: never;
- };
- readonly "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
- };
- /**
- * Get an environment public key
- * @description Get the public key for an environment, which you need to encrypt environment
- * secrets. You need to encrypt a secret before you can create or update secrets.
- *
- * Anyone with read access to the repository can use this endpoint.
- * If the repository is private you must use an access token with the `repo` scope.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
- */
- readonly get: operations["actions/get-environment-public-key"];
- readonly put?: never;
- readonly post?: never;
- readonly delete?: never;
- readonly options?: never;
- readonly head?: never;
- readonly patch?: never;
- readonly trace?: never;
- };
- readonly "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
- };
- /**
- * Get an environment secret
- * @description Gets a single environment secret without revealing its encrypted value.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
- */
- readonly get: operations["actions/get-environment-secret"];
- /**
- * Create or update an environment secret
- * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
- */
- readonly put: operations["actions/create-or-update-environment-secret"];
- readonly post?: never;
- /**
- * Delete an environment secret
- * @description Deletes a secret in an environment using the secret name.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `secrets` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
- */
- readonly delete: operations["actions/delete-environment-secret"];
- readonly options?: never;
- readonly head?: never;
- readonly patch?: never;
- readonly trace?: never;
- };
- readonly "/repositories/{repository_id}/environments/{environment_name}/variables": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
- };
- /**
- * List environment variables
- * @description Lists all environment variables.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `environments:read` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
- */
- readonly get: operations["actions/list-environment-variables"];
- readonly put?: never;
- /**
- * Create an environment variable
- * @description Create an environment variable that you can reference in a GitHub Actions workflow.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `environment:write` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
- */
- readonly post: operations["actions/create-environment-variable"];
- readonly delete?: never;
- readonly options?: never;
- readonly head?: never;
- readonly patch?: never;
- readonly trace?: never;
- };
- readonly "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
- };
- /**
- * Get an environment variable
- * @description Gets a specific variable in an environment.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `environments:read` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
- */
- readonly get: operations["actions/get-environment-variable"];
- readonly put?: never;
- readonly post?: never;
- /**
- * Delete an environment variable
- * @description Deletes an environment variable using the variable name.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `environment:write` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
- */
- readonly delete: operations["actions/delete-environment-variable"];
- readonly options?: never;
- readonly head?: never;
- /**
- * Update an environment variable
- * @description Updates an environment variable that you can reference in a GitHub Actions workflow.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `environment:write` repository permission to use this endpoint.
- * Authenticated users must have collaborator access to a repository to create, update, or read variables.
- */
- readonly patch: operations["actions/update-environment-variable"];
- readonly trace?: never;
- };
readonly "/search/code": {
readonly parameters: {
readonly query?: never;
@@ -13202,7 +13975,9 @@ 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 discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.
*
- * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List all discussions on a team's page.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/list-discussions-legacy"];
readonly put?: never;
@@ -13211,9 +13986,11 @@ 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 a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.
*
- * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Creates a new discussion post on a team's page.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["teams/create-discussion-legacy"];
readonly delete?: never;
@@ -13234,7 +14011,9 @@ 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 [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.
*
- * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Get a specific discussion on a team's page.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/get-discussion-legacy"];
readonly put?: never;
@@ -13244,7 +14023,9 @@ 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 [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.
*
- * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Delete a discussion from a team's page.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly delete: operations["teams/delete-discussion-legacy"];
readonly options?: never;
@@ -13254,7 +14035,9 @@ 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 [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.
*
- * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Edits the title and body text of a discussion post. Only the parameters you provide are updated.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly patch: operations["teams/update-discussion-legacy"];
readonly trace?: never;
@@ -13271,7 +14054,9 @@ 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 discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.
*
- * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List all comments on a team discussion.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/list-discussion-comments-legacy"];
readonly put?: never;
@@ -13280,9 +14065,11 @@ 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 a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
*
- * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Creates a new comment on a team discussion.
*
* 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["teams/create-discussion-comment-legacy"];
readonly delete?: never;
@@ -13303,7 +14090,9 @@ 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 [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
*
- * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Get a specific comment on a team discussion.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["teams/get-discussion-comment-legacy"];
readonly put?: never;
@@ -13313,7 +14102,9 @@ 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 [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
*
- * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Deletes a comment on a team discussion.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly delete: operations["teams/delete-discussion-comment-legacy"];
readonly options?: never;
@@ -13323,7 +14114,9 @@ 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 [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
*
- * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Edits the body text of a discussion comment.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly patch: operations["teams/update-discussion-comment-legacy"];
readonly trace?: never;
@@ -13340,7 +14133,9 @@ 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/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/).
+ * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["reactions/list-for-team-discussion-comment-legacy"];
readonly put?: never;
@@ -13349,7 +14144,11 @@ 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/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.
+ * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["reactions/create-for-team-discussion-comment-legacy"];
readonly delete?: never;
@@ -13370,7 +14169,9 @@ 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/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/).
+ * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
readonly get: operations["reactions/list-for-team-discussion-legacy"];
readonly put?: never;
@@ -13379,7 +14180,11 @@ 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/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.
+ * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
+ *
+ * A response with an HTTP `200` status means that you already added the reaction type to this team discussion.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
readonly post: operations["reactions/create-for-team-discussion-legacy"];
readonly delete?: never;
@@ -13464,7 +14269,7 @@ export interface paths {
*
* **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
*
- * Note that 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)."
+ * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
readonly put: operations["teams/add-member-legacy"];
readonly post?: never;
@@ -13648,7 +14453,7 @@ export interface paths {
*
* 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.
*
- * 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)."
+ * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
readonly put: operations["teams/add-or-update-repo-permissions-legacy"];
readonly post?: never;
@@ -13695,9 +14500,7 @@ export interface paths {
};
/**
* Get the authenticated user
- * @description If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information.
- *
- * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information.
+ * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information.
*/
readonly get: operations["users/get-authenticated"];
readonly put?: never;
@@ -13771,9 +14574,7 @@ export interface paths {
* List codespaces for the authenticated user
* @description Lists the authenticated user's codespaces.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-for-authenticated-user"];
readonly put?: never;
@@ -13783,9 +14584,7 @@ export interface paths {
*
* This endpoint requires either a `repository_id` OR a `pull_request` but not both.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/create-for-authenticated-user"];
readonly delete?: never;
@@ -13806,9 +14605,9 @@ export interface paths {
* @description Lists all development environment secrets available for a user's codespaces without revealing their
* encrypted values.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-secrets-for-authenticated-user"];
readonly put?: never;
@@ -13830,9 +14629,9 @@ export interface paths {
* Get public key for the authenticated user
* @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-public-key-for-authenticated-user"];
readonly put?: never;
@@ -13854,9 +14653,9 @@ export interface paths {
* Get a secret for the authenticated user
* @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-secret-for-authenticated-user"];
/**
@@ -13864,9 +14663,9 @@ export interface paths {
* @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly put: operations["codespaces/create-or-update-secret-for-authenticated-user"];
readonly post?: never;
@@ -13874,9 +14673,9 @@ export interface paths {
* Delete a secret for the authenticated user
* @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly delete: operations["codespaces/delete-secret-for-authenticated-user"];
readonly options?: never;
@@ -13895,18 +14694,18 @@ export interface paths {
* List selected repositories for a user secret
* @description List the repositories that have been granted the ability to use a user's development environment secret.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"];
/**
* Set selected repositories for a user secret
* @description Select the repositories that will use a user's development environment secret.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"];
readonly post?: never;
@@ -13927,16 +14726,20 @@ export interface paths {
/**
* Add a selected repository to a user secret
* @description Adds a repository to the selected repositories for a user's development environment secret.
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint.
+ *
+ * The authenticated user must have Codespaces access to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly put: operations["codespaces/add-repository-for-secret-for-authenticated-user"];
readonly post?: never;
/**
* Remove a selected repository from a user secret
* @description Removes a repository from the selected repositories for a user's development environment secret.
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.
+ *
+ * The authenticated user must have Codespaces access to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
readonly delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"];
readonly options?: never;
@@ -13955,9 +14758,7 @@ export interface paths {
* Get a codespace for the authenticated user
* @description Gets information about a user's codespace.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-for-authenticated-user"];
readonly put?: never;
@@ -13966,9 +14767,7 @@ export interface paths {
* Delete a codespace for the authenticated user
* @description Deletes a user's codespace.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly delete: operations["codespaces/delete-for-authenticated-user"];
readonly options?: never;
@@ -13979,9 +14778,7 @@ export interface paths {
*
* If you specify a new machine type it will be applied the next time your codespace is started.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly patch: operations["codespaces/update-for-authenticated-user"];
readonly trace?: never;
@@ -14001,9 +14798,7 @@ export interface paths {
*
* If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.
*
- * You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/export-for-authenticated-user"];
readonly delete?: never;
@@ -14023,9 +14818,7 @@ export interface paths {
* Get details about a codespace export
* @description Gets information about an export of a codespace.
*
- * You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/get-export-details-for-authenticated-user"];
readonly put?: never;
@@ -14047,9 +14840,7 @@ export interface paths {
* List machine types for a codespace
* @description List the machine types a codespace can transition to use.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly get: operations["codespaces/codespace-machines-for-authenticated-user"];
readonly put?: never;
@@ -14077,9 +14868,7 @@ export interface paths {
*
* This will fail for a codespace that is already published, meaning it has an associated repository.
*
- * You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/publish-for-authenticated-user"];
readonly delete?: never;
@@ -14101,9 +14890,7 @@ export interface paths {
* Start a codespace for the authenticated user
* @description Starts a user's codespace.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/start-for-authenticated-user"];
readonly delete?: never;
@@ -14125,9 +14912,7 @@ export interface paths {
* Stop a codespace for the authenticated user
* @description Stops a user's codespace.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
readonly post: operations["codespaces/stop-for-authenticated-user"];
readonly delete?: never;
@@ -14146,7 +14931,8 @@ export interface paths {
/**
* Get list of conflicting packages during Docker migration for authenticated-user
* @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
*/
readonly get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"];
readonly put?: never;
@@ -14186,18 +14972,21 @@ export interface paths {
};
/**
* List email addresses for the authenticated user
- * @description Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.
+ * @description Lists all of your email addresses, and specifies which one is visible
+ * to the public.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
*/
readonly get: operations["users/list-emails-for-authenticated-user"];
readonly put?: never;
/**
* Add an email address for the authenticated user
- * @description This endpoint is accessible with the `user` scope.
+ * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly post: operations["users/add-email-for-authenticated-user"];
/**
* Delete an email address for the authenticated user
- * @description This endpoint is accessible with the `user` scope.
+ * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly delete: operations["users/delete-email-for-authenticated-user"];
readonly options?: never;
@@ -14256,15 +15045,15 @@ export interface paths {
readonly get: operations["users/check-person-is-followed-by-authenticated"];
/**
* Follow a user
- * @description Note that 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)."
+ * @description Note that 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/guides/getting-started-with-the-rest-api#http-method)."
*
- * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
*/
readonly put: operations["users/follow"];
readonly post?: never;
/**
* Unfollow a user
- * @description Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.
+ * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
*/
readonly delete: operations["users/unfollow"];
readonly options?: never;
@@ -14281,13 +15070,17 @@ export interface paths {
};
/**
* List GPG keys for the authenticated user
- * @description Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Lists the current user's GPG keys.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
*/
readonly get: operations["users/list-gpg-keys-for-authenticated-user"];
readonly put?: never;
/**
* Create a GPG key for the authenticated user
- * @description Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Adds a GPG key to the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
*/
readonly post: operations["users/create-gpg-key-for-authenticated-user"];
readonly delete?: never;
@@ -14305,14 +15098,18 @@ export interface paths {
};
/**
* Get a GPG key for the authenticated user
- * @description View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description View extended details for a single GPG key.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
*/
readonly get: operations["users/get-gpg-key-for-authenticated-user"];
readonly put?: never;
readonly post?: never;
/**
* Delete a GPG key for the authenticated user
- * @description Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Removes a GPG key from the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.
*/
readonly delete: operations["users/delete-gpg-key-for-authenticated-user"];
readonly options?: never;
@@ -14331,8 +15128,6 @@ export interface paths {
* List app installations accessible to the user access token
* @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
*
- * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint.
- *
* The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
*
* You can find the permissions for the installation under the `permissions` key.
@@ -14359,8 +15154,6 @@ export interface paths {
*
* The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
*
- * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint.
- *
* The access the user has to each repository is included in the hash under the `permissions` key.
*/
readonly get: operations["apps/list-installation-repos-for-authenticated-user"];
@@ -14383,16 +15176,12 @@ export interface paths {
/**
* Add a repository to an app installation
* @description Add a single repository to an installation. The authenticated user must have admin access to the repository.
- *
- * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.
*/
readonly put: operations["apps/add-repo-to-installation-for-authenticated-user"];
readonly post?: never;
/**
* Remove a repository from an app installation
* @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.
- *
- * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.
*/
readonly delete: operations["apps/remove-repo-from-installation-for-authenticated-user"];
readonly options?: never;
@@ -14443,6 +15232,13 @@ export interface paths {
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
readonly get: operations["issues/list-for-authenticated-user"];
readonly put?: never;
@@ -14462,13 +15258,17 @@ export interface paths {
};
/**
* List public SSH keys for the authenticated user
- * @description Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Lists the public SSH keys for the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
*/
readonly get: operations["users/list-public-ssh-keys-for-authenticated-user"];
readonly put?: never;
/**
* Create a public SSH key for the authenticated user
- * @description Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Adds a public SSH key to the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
*/
readonly post: operations["users/create-public-ssh-key-for-authenticated-user"];
readonly delete?: never;
@@ -14486,14 +15286,18 @@ export interface paths {
};
/**
* Get a public SSH key for the authenticated user
- * @description View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description View extended details for a single public SSH key.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
*/
readonly get: operations["users/get-public-ssh-key-for-authenticated-user"];
readonly put?: never;
readonly post?: never;
/**
* Delete a public SSH key for the authenticated user
- * @description Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @description Removes a public SSH key from the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.
*/
readonly delete: operations["users/delete-public-ssh-key-for-authenticated-user"];
readonly options?: never;
@@ -14510,7 +15314,7 @@ export interface paths {
};
/**
* List subscriptions for the authenticated user
- * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps).
+ * @description Lists the active subscriptions for the authenticated user.
*/
readonly get: operations["apps/list-subscriptions-for-authenticated-user"];
readonly put?: never;
@@ -14530,7 +15334,7 @@ export interface paths {
};
/**
* List subscriptions for the authenticated user (stubbed)
- * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps).
+ * @description Lists the active subscriptions for the authenticated user.
*/
readonly get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"];
readonly put?: never;
@@ -14731,9 +15535,7 @@ export interface paths {
* List organizations for the authenticated user
* @description List organizations for the authenticated user.
*
- * **OAuth scope requirements**
- *
- * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.
+ * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.
*/
readonly get: operations["orgs/list-for-authenticated-user"];
readonly put?: never;
@@ -14755,7 +15557,7 @@ export interface paths {
* List packages for the authenticated user's namespace
* @description Lists packages owned by the authenticated user within the user's namespace.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/list-packages-for-authenticated-user"];
readonly put?: never;
@@ -14777,7 +15579,7 @@ export interface paths {
* Get a package for the authenticated user
* @description Gets a specific package for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-package-for-authenticated-user"];
readonly put?: never;
@@ -14786,8 +15588,7 @@ export interface paths {
* Delete a package for the authenticated user
* @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes.
- * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly delete: operations["packages/delete-package-for-authenticated-user"];
readonly options?: never;
@@ -14812,7 +15613,7 @@ export interface paths {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly post: operations["packages/restore-package-for-authenticated-user"];
readonly delete?: never;
@@ -14832,7 +15633,7 @@ export interface paths {
* List package versions for a package owned by the authenticated user
* @description Lists package versions for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"];
readonly put?: never;
@@ -14854,7 +15655,7 @@ export interface paths {
* Get a package version for the authenticated user
* @description Gets a specific package version for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-package-version-for-authenticated-user"];
readonly put?: never;
@@ -14863,8 +15664,9 @@ export interface paths {
* Delete a package version for the authenticated user
* @description Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes.
- * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * The authenticated user must have admin permissions in the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly delete: operations["packages/delete-package-version-for-authenticated-user"];
readonly options?: never;
@@ -14889,7 +15691,7 @@ export interface paths {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly post: operations["packages/restore-package-version-for-authenticated-user"];
readonly delete?: never;
@@ -14927,7 +15729,11 @@ export interface paths {
};
/**
* List public email addresses for the authenticated user
- * @description Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.
+ * @description Lists your publicly visible email address, which you can set with the
+ * [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)
+ * endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
*/
readonly get: operations["users/list-public-emails-for-authenticated-user"];
readonly put?: never;
@@ -14957,12 +15763,7 @@ export interface paths {
* Create a repository for the authenticated user
* @description Creates a new repository for the authenticated user.
*
- * **OAuth scope requirements**
- *
- * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
- *
- * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- * * `repo` scope to create a private repository.
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
*/
readonly post: operations["repos/create-for-authenticated-user"];
readonly delete?: never;
@@ -15024,12 +15825,16 @@ export interface paths {
readonly put?: never;
/**
* Add social accounts for the authenticated user
- * @description Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope.
+ * @description Add one or more social accounts to the authenticated user's profile.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly post: operations["users/add-social-account-for-authenticated-user"];
/**
* Delete social accounts for the authenticated user
- * @description Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope.
+ * @description Deletes one or more social accounts from the authenticated user's profile.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly delete: operations["users/delete-social-account-for-authenticated-user"];
readonly options?: never;
@@ -15046,13 +15851,17 @@ export interface paths {
};
/**
* List SSH signing keys for the authenticated user
- * @description Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)."
+ * @description Lists the SSH signing keys for the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
*/
readonly get: operations["users/list-ssh-signing-keys-for-authenticated-user"];
readonly put?: never;
/**
* Create a SSH signing key for the authenticated user
- * @description Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)."
+ * @description Creates an SSH signing key for the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.
*/
readonly post: operations["users/create-ssh-signing-key-for-authenticated-user"];
readonly delete?: never;
@@ -15070,14 +15879,18 @@ export interface paths {
};
/**
* Get an SSH signing key for the authenticated user
- * @description Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)."
+ * @description Gets extended details for an SSH signing key.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
*/
readonly get: operations["users/get-ssh-signing-key-for-authenticated-user"];
readonly put?: never;
readonly post?: never;
/**
* Delete an SSH signing key for the authenticated user
- * @description Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)."
+ * @description Deletes an SSH signing key from the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.
*/
readonly delete: operations["users/delete-ssh-signing-key-for-authenticated-user"];
readonly options?: never;
@@ -15096,7 +15909,9 @@ export interface paths {
* List repositories starred by the authenticated user
* @description Lists repositories the authenticated user has starred.
*
- * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
*/
readonly get: operations["activity/list-repos-starred-by-authenticated-user"];
readonly put?: never;
@@ -15121,7 +15936,7 @@ export interface paths {
readonly get: operations["activity/check-repo-is-starred-by-authenticated-user"];
/**
* Star a repository for the authenticated user
- * @description Note that 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)."
+ * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
readonly put: operations["activity/star-repo-for-authenticated-user"];
readonly post?: never;
@@ -15164,7 +15979,12 @@ export interface paths {
};
/**
* List teams for the authenticated user
- * @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token.
+ * @description List all of the teams across all of the organizations to which the authenticated
+ * user belongs.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.
+ *
+ * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.
*/
readonly get: operations["teams/list-for-authenticated-user"];
readonly put?: never;
@@ -15208,9 +16028,7 @@ export interface paths {
* Get a user
* @description Provides publicly available information about someone with a GitHub account.
*
- * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below"
- *
- * 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 `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/guides/getting-started-with-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/users/emails)".
*/
@@ -15233,7 +16051,8 @@ export interface paths {
/**
* Get list of conflicting packages during Docker migration for user
* @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
*/
readonly get: operations["packages/list-docker-migration-conflicting-packages-for-user"];
readonly put?: never;
@@ -15407,14 +16226,11 @@ export interface paths {
};
/**
* Get contextual information for a user
- * @description Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
+ * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
*
- * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:
+ * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).
*
- * ```shell
- * curl -u username:token
- * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
- * ```
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
readonly get: operations["users/get-context-for-user"];
readonly put?: never;
@@ -15500,7 +16316,7 @@ export interface paths {
* List packages for a user
* @description Lists all packages in a user's namespace for which the requesting user has access.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/list-packages-for-user"];
readonly put?: never;
@@ -15522,7 +16338,7 @@ export interface paths {
* Get a package for a user
* @description Gets a specific package metadata for a public package owned by a user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-package-for-user"];
readonly put?: never;
@@ -15531,9 +16347,9 @@ export interface paths {
* Delete a package for a user
* @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly delete: operations["packages/delete-package-for-user"];
readonly options?: never;
@@ -15558,9 +16374,9 @@ export interface paths {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly post: operations["packages/restore-package-for-user"];
readonly delete?: never;
@@ -15580,7 +16396,7 @@ export interface paths {
* List package versions for a package owned by a user
* @description Lists package versions for a public package owned by a specified user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-all-package-versions-for-package-owned-by-user"];
readonly put?: never;
@@ -15602,7 +16418,7 @@ export interface paths {
* Get a package version for a user
* @description Gets a specific package version for a public package owned by a specified user.
*
- * At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly get: operations["packages/get-package-version-for-user"];
readonly put?: never;
@@ -15611,9 +16427,9 @@ export interface paths {
* Delete package version for a user
* @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly delete: operations["packages/delete-package-version-for-user"];
readonly options?: never;
@@ -15638,9 +16454,9 @@ export interface paths {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
readonly post: operations["packages/restore-package-version-for-user"];
readonly delete?: never;
@@ -15678,7 +16494,7 @@ export interface paths {
};
/**
* List events received by the authenticated user
- * @description These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.
+ * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.
*/
readonly get: operations["activity/list-received-events-for-user"];
readonly put?: never;
@@ -15715,7 +16531,7 @@ export interface paths {
};
/**
* List repositories for a user
- * @description Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.
+ * @description Lists public repositories for the specified user.
*/
readonly get: operations["repos/list-for-user"];
readonly put?: never;
@@ -15739,7 +16555,7 @@ export interface paths {
*
* Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * Access tokens must have the `user` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly get: operations["billing/get-github-actions-billing-user"];
readonly put?: never;
@@ -15763,7 +16579,7 @@ export interface paths {
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `user` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly get: operations["billing/get-github-packages-billing-user"];
readonly put?: never;
@@ -15787,7 +16603,7 @@ export interface paths {
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `user` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
readonly get: operations["billing/get-shared-storage-billing-user"];
readonly put?: never;
@@ -15849,7 +16665,9 @@ export interface paths {
* List repositories starred by a user
* @description Lists repositories a user has starred.
*
- * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
*/
readonly get: operations["activity/list-repos-starred-by-user"];
readonly put?: never;
@@ -15949,8 +16767,11 @@ export interface components {
readonly following_url: string;
/** Format: uri-template */
readonly gists_url: string;
- /** Format: uri-template */
- readonly hub_url: string;
+ /**
+ * Format: uri-template
+ * @deprecated
+ */
+ readonly hub_url?: string;
/** Format: uri-template */
readonly issue_search_url: string;
/** Format: uri-template */
@@ -15997,210 +16818,212 @@ export interface components {
* @enum {string}
*/
readonly "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift";
- /**
- * Simple User
- * @description A GitHub user.
- */
- readonly "simple-user": {
- readonly name?: string | null;
- readonly email?: string | null;
- /** @example octocat */
- readonly login: string;
- /** @example 1 */
- readonly id: number;
- /** @example MDQ6VXNlcjE= */
- readonly node_id: string;
- /**
- * Format: uri
- * @example https://github.com/images/error/octocat_happy.gif
- */
- readonly avatar_url: string;
- /** @example 41d064eb2195891e12d0413f63227ea7 */
- readonly gravatar_id: string | null;
- /**
- * Format: uri
- * @example https://api.github.com/users/octocat
- */
- readonly url: string;
- /**
- * Format: uri
- * @example https://github.com/octocat
- */
- readonly html_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/users/octocat/followers
- */
- readonly followers_url: string;
- /** @example https://api.github.com/users/octocat/following{/other_user} */
- readonly following_url: string;
- /** @example https://api.github.com/users/octocat/gists{/gist_id} */
- readonly gists_url: string;
- /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */
- readonly starred_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/users/octocat/subscriptions
- */
- readonly subscriptions_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/users/octocat/orgs
- */
- readonly organizations_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/users/octocat/repos
- */
- readonly repos_url: string;
- /** @example https://api.github.com/users/octocat/events{/privacy} */
- readonly events_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/users/octocat/received_events
- */
- readonly received_events_url: string;
- /** @example User */
- readonly type: string;
- readonly site_admin: boolean;
- /** @example "2020-07-09T00:17:55Z" */
- readonly starred_at?: string;
- };
- /**
- * @description The type of credit the user is receiving.
- * @enum {string}
- */
- readonly "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other";
- /** @description A GitHub Security Advisory. */
- readonly "global-advisory": {
- /** @description The GitHub Security Advisory ID. */
- readonly ghsa_id: string;
- /** @description The Common Vulnerabilities and Exposures (CVE) ID. */
- readonly cve_id: string | null;
- /** @description The API URL for the advisory. */
- readonly url: string;
- /**
- * Format: uri
- * @description The URL for the advisory.
- */
- readonly html_url: string;
- /**
- * Format: uri
- * @description The API URL for the repository advisory.
- */
- readonly repository_advisory_url: string | null;
- /** @description A short summary of the advisory. */
- readonly summary: string;
- /** @description A detailed description of what the advisory entails. */
- readonly description: string | null;
- /**
- * @description The type of advisory.
- * @enum {string}
- */
- readonly type: "reviewed" | "unreviewed" | "malware";
- /**
- * @description The severity of the advisory.
- * @enum {string}
- */
- readonly severity: "critical" | "high" | "medium" | "low" | "unknown";
- /**
- * Format: uri
- * @description The URL of the advisory's source code.
- */
- readonly source_code_location: string | null;
- readonly identifiers: {
- /**
- * @description The type of identifier.
- * @enum {string}
- */
- readonly type: "CVE" | "GHSA";
- /** @description The identifier value. */
- readonly value: string;
- }[] | null;
- readonly references: string[] | null;
- /**
- * Format: date-time
- * @description The date and time of when the advisory was published, in ISO 8601 format.
- */
- readonly published_at: string;
- /**
- * Format: date-time
- * @description The date and time of when the advisory was last updated, in ISO 8601 format.
- */
- readonly updated_at: string;
- /**
- * Format: date-time
- * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.
- */
- readonly github_reviewed_at: string | null;
- /**
- * Format: date-time
- * @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 nvd_published_at: string | null;
- /**
- * Format: date-time
- * @description The date and time of when the advisory was withdrawn, in ISO 8601 format.
- */
- readonly withdrawn_at: string | null;
- /** @description The products and respective version ranges affected by the advisory. */
- readonly vulnerabilities: {
- /** @description The name of the package affected by the vulnerability. */
- readonly package: {
- readonly ecosystem: components["schemas"]["security-advisory-ecosystems"];
- /** @description The unique package name within its ecosystem. */
- readonly name: string | null;
- } | null;
- /** @description The range of the package versions affected by the vulnerability. */
- readonly vulnerable_version_range: string | null;
- /** @description The package version that resolve the vulnerability. */
- readonly first_patched_version: string | null;
- /** @description The functions in the package that are affected by the vulnerability. */
- readonly vulnerable_functions: string[] | null;
- }[] | null;
- readonly cvss: {
- /** @description The CVSS vector. */
- readonly vector_string: string | null;
- /** @description The CVSS score. */
- readonly score: number | null;
+ /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */
+ readonly vulnerability: {
+ /** @description The name of the package affected by the vulnerability. */
+ readonly package: {
+ readonly ecosystem: components["schemas"]["security-advisory-ecosystems"];
+ /** @description The unique package name within its ecosystem. */
+ readonly name: string | null;
} | null;
- readonly cwes: {
- /** @description The Common Weakness Enumeration (CWE) identifier. */
- readonly cwe_id: string;
- /** @description The name of the CWE. */
- readonly name: string;
- }[] | null;
- /** @description The users who contributed to the advisory. */
- readonly credits: {
- readonly user: components["schemas"]["simple-user"];
- readonly type: components["schemas"]["security-advisory-credit-types"];
- }[] | null;
- };
- /**
- * Basic Error
- * @description Basic Error
- */
- readonly "basic-error": {
- readonly message?: string;
- readonly documentation_url?: string;
- readonly url?: string;
- readonly status?: string;
- };
- /**
- * Validation Error Simple
- * @description Validation Error Simple
- */
- readonly "validation-error-simple": {
- readonly message: string;
- readonly documentation_url: string;
- readonly errors?: string[];
+ /** @description The range of the package versions affected by the vulnerability. */
+ readonly vulnerable_version_range: string | null;
+ /** @description The package version that resolves the vulnerability. */
+ readonly first_patched_version: string | null;
+ /** @description The functions in the package that are affected by the vulnerability. */
+ readonly vulnerable_functions: string[] | null;
};
/**
* Simple User
* @description A GitHub user.
*/
- readonly "nullable-simple-user": {
+ readonly "simple-user": {
+ readonly name?: string | null;
+ readonly email?: string | null;
+ /** @example octocat */
+ readonly login: string;
+ /** @example 1 */
+ readonly id: number;
+ /** @example MDQ6VXNlcjE= */
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @example https://github.com/images/error/octocat_happy.gif
+ */
+ readonly avatar_url: string;
+ /** @example 41d064eb2195891e12d0413f63227ea7 */
+ readonly gravatar_id: string | null;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat
+ */
+ readonly url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat
+ */
+ readonly html_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/followers
+ */
+ readonly followers_url: string;
+ /** @example https://api.github.com/users/octocat/following{/other_user} */
+ readonly following_url: string;
+ /** @example https://api.github.com/users/octocat/gists{/gist_id} */
+ readonly gists_url: string;
+ /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */
+ readonly starred_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/subscriptions
+ */
+ readonly subscriptions_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/orgs
+ */
+ readonly organizations_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/repos
+ */
+ readonly repos_url: string;
+ /** @example https://api.github.com/users/octocat/events{/privacy} */
+ readonly events_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/received_events
+ */
+ readonly received_events_url: string;
+ /** @example User */
+ readonly type: string;
+ readonly site_admin: boolean;
+ /** @example "2020-07-09T00:17:55Z" */
+ readonly starred_at?: string;
+ };
+ /**
+ * @description The type of credit the user is receiving.
+ * @enum {string}
+ */
+ readonly "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other";
+ /** @description A GitHub Security Advisory. */
+ readonly "global-advisory": {
+ /** @description The GitHub Security Advisory ID. */
+ readonly ghsa_id: string;
+ /** @description The Common Vulnerabilities and Exposures (CVE) ID. */
+ readonly cve_id: string | null;
+ /** @description The API URL for the advisory. */
+ readonly url: string;
+ /**
+ * Format: uri
+ * @description The URL for the advisory.
+ */
+ readonly html_url: string;
+ /**
+ * Format: uri
+ * @description The API URL for the repository advisory.
+ */
+ readonly repository_advisory_url: string | null;
+ /** @description A short summary of the advisory. */
+ readonly summary: string;
+ /** @description A detailed description of what the advisory entails. */
+ readonly description: string | null;
+ /**
+ * @description The type of advisory.
+ * @enum {string}
+ */
+ readonly type: "reviewed" | "unreviewed" | "malware";
+ /**
+ * @description The severity of the advisory.
+ * @enum {string}
+ */
+ readonly severity: "critical" | "high" | "medium" | "low" | "unknown";
+ /**
+ * Format: uri
+ * @description The URL of the advisory's source code.
+ */
+ readonly source_code_location: string | null;
+ readonly identifiers: {
+ /**
+ * @description The type of identifier.
+ * @enum {string}
+ */
+ readonly type: "CVE" | "GHSA";
+ /** @description The identifier value. */
+ readonly value: string;
+ }[] | null;
+ readonly references: string[] | null;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was published, in ISO 8601 format.
+ */
+ readonly published_at: string;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was last updated, in ISO 8601 format.
+ */
+ readonly updated_at: string;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.
+ */
+ readonly github_reviewed_at: string | null;
+ /**
+ * Format: date-time
+ * @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 nvd_published_at: string | null;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was withdrawn, in ISO 8601 format.
+ */
+ readonly withdrawn_at: string | null;
+ /** @description The products and respective version ranges affected by the advisory. */
+ readonly vulnerabilities: components["schemas"]["vulnerability"][] | null;
+ readonly cvss: {
+ /** @description The CVSS vector. */
+ readonly vector_string: string | null;
+ /** @description The CVSS score. */
+ readonly score: number | null;
+ } | null;
+ readonly cwes: {
+ /** @description The Common Weakness Enumeration (CWE) identifier. */
+ readonly cwe_id: string;
+ /** @description The name of the CWE. */
+ readonly name: string;
+ }[] | null;
+ /** @description The users who contributed to the advisory. */
+ readonly credits: {
+ readonly user: components["schemas"]["simple-user"];
+ readonly type: components["schemas"]["security-advisory-credit-types"];
+ }[] | null;
+ };
+ /**
+ * Basic Error
+ * @description Basic Error
+ */
+ readonly "basic-error": {
+ readonly message?: string;
+ readonly documentation_url?: string;
+ readonly url?: string;
+ readonly status?: string;
+ };
+ /**
+ * Validation Error Simple
+ * @description Validation Error Simple
+ */
+ readonly "validation-error-simple": {
+ readonly message: string;
+ readonly documentation_url: string;
+ readonly errors?: string[];
+ };
+ /**
+ * Simple User
+ * @description A GitHub user.
+ */
+ readonly "nullable-simple-user": {
readonly name?: string | null;
readonly email?: string | null;
/** @example octocat */
@@ -16346,7 +17169,7 @@ export interface components {
readonly webhook_secret?: string | null;
/** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */
readonly pem?: string;
- };
+ } | null;
/**
* Format: uri
* @description The URL to which the payloads will be delivered.
@@ -16642,11 +17465,21 @@ export interface components {
* @enum {string}
*/
readonly checks?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to create, edit, delete, and list Codespaces.
+ * @enum {string}
+ */
+ readonly codespaces?: "read" | "write";
/**
* @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
* @enum {string}
*/
readonly contents?: "read" | "write";
+ /**
+ * @description The leve of permission to grant the access token to manage Dependabot secrets.
+ * @enum {string}
+ */
+ readonly dependabot_secrets?: "read" | "write";
/**
* @description The level of permission to grant the access token for deployments and deployment statuses.
* @enum {string}
@@ -16682,6 +17515,11 @@ export interface components {
* @enum {string}
*/
readonly pull_requests?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.
+ * @enum {string}
+ */
+ readonly repository_custom_properties?: "read" | "write";
/**
* @description The level of permission to grant the access token to manage the post-receive hooks for a repository.
* @enum {string}
@@ -16738,20 +17576,35 @@ export interface components {
*/
readonly organization_administration?: "read" | "write";
/**
- * @description The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.
+ * @description The level of permission to grant the access token for custom repository roles management.
* @enum {string}
*/
readonly organization_custom_roles?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for custom organization roles management.
+ * @enum {string}
+ */
+ readonly organization_custom_org_roles?: "read" | "write";
/**
* @description The level of permission to grant the access token for custom property management.
* @enum {string}
*/
readonly organization_custom_properties?: "read" | "write" | "admin";
+ /**
+ * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change.
+ * @enum {string}
+ */
+ readonly organization_copilot_seat_management?: "write";
/**
* @description The level of permission to grant the access token to view and manage announcement banners for an organization.
* @enum {string}
*/
readonly organization_announcement_banners?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view events triggered by an activity in an organization.
+ * @enum {string}
+ */
+ readonly organization_events?: "read";
/**
* @description The level of permission to grant the access token to manage the post-receive hooks for an organization.
* @enum {string}
@@ -16802,6 +17655,41 @@ export interface components {
* @enum {string}
*/
readonly team_discussions?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage the email addresses belonging to a user.
+ * @enum {string}
+ */
+ readonly email_addresses?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage the followers belonging to a user.
+ * @enum {string}
+ */
+ readonly followers?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage git SSH keys.
+ * @enum {string}
+ */
+ readonly git_ssh_keys?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view and manage GPG keys belonging to a user.
+ * @enum {string}
+ */
+ readonly gpg_keys?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view and manage interaction limits on a repository.
+ * @enum {string}
+ */
+ readonly interaction_limits?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage the profile settings belonging to a user.
+ * @enum {string}
+ */
+ readonly profile?: "write";
+ /**
+ * @description The level of permission to grant the access token to list and manage repositories a user is starring.
+ * @enum {string}
+ */
+ readonly starring?: "read" | "write";
};
/**
* Installation
@@ -16904,7 +17792,6 @@ export interface components {
/** @example octocat/Hello-World */
readonly full_name: string;
readonly license: components["schemas"]["nullable-license-simple"];
- readonly organization?: components["schemas"]["nullable-simple-user"];
readonly forks: number;
readonly permissions?: {
readonly admin: boolean;
@@ -17072,7 +17959,7 @@ export interface components {
/** @example 80 */
readonly watchers_count: number;
/**
- * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
* @example 108
*/
readonly size: number;
@@ -17155,150 +18042,6 @@ export interface components {
* @example true
*/
readonly allow_rebase_merge: boolean;
- readonly template_repository?: {
- readonly id?: number;
- readonly node_id?: string;
- readonly name?: string;
- readonly full_name?: string;
- readonly owner?: {
- readonly login?: string;
- readonly id?: number;
- readonly node_id?: string;
- readonly avatar_url?: string;
- readonly gravatar_id?: string;
- readonly url?: string;
- readonly html_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly organizations_url?: string;
- readonly repos_url?: string;
- readonly events_url?: string;
- readonly received_events_url?: string;
- readonly type?: string;
- readonly site_admin?: boolean;
- };
- readonly private?: boolean;
- readonly html_url?: string;
- readonly description?: string;
- readonly fork?: boolean;
- readonly url?: string;
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly forks_url?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly git_url?: string;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly notifications_url?: string;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly ssh_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly clone_url?: string;
- readonly mirror_url?: string;
- readonly hooks_url?: string;
- readonly svn_url?: string;
- readonly homepage?: string;
- readonly language?: string;
- readonly forks_count?: number;
- readonly stargazers_count?: number;
- readonly watchers_count?: number;
- readonly size?: number;
- readonly default_branch?: string;
- readonly open_issues_count?: number;
- readonly is_template?: boolean;
- readonly topics?: string[];
- readonly has_issues?: boolean;
- readonly has_projects?: boolean;
- readonly has_wiki?: boolean;
- readonly has_pages?: boolean;
- readonly has_downloads?: boolean;
- readonly archived?: boolean;
- readonly disabled?: boolean;
- readonly visibility?: string;
- readonly pushed_at?: string;
- readonly created_at?: string;
- readonly updated_at?: string;
- readonly permissions?: {
- readonly admin?: boolean;
- readonly maintain?: boolean;
- readonly push?: boolean;
- readonly triage?: boolean;
- readonly pull?: boolean;
- };
- readonly allow_rebase_merge?: boolean;
- readonly temp_clone_token?: string;
- readonly allow_squash_merge?: boolean;
- readonly allow_auto_merge?: boolean;
- readonly delete_branch_on_merge?: boolean;
- readonly allow_update_branch?: boolean;
- readonly use_squash_pr_title_as_default?: boolean;
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- readonly allow_merge_commit?: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
- } | null;
readonly temp_clone_token?: string;
/**
* @description Whether to allow squash merges for pull requests.
@@ -17377,8 +18120,6 @@ export interface components {
* @default false
*/
readonly web_commit_signoff_required: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
readonly open_issues: number;
readonly watchers: number;
readonly master_branch?: string;
@@ -17907,6 +18648,51 @@ export interface components {
/** Format: uri */
readonly html_url: string | null;
};
+ /**
+ * Copilot Usage Metrics
+ * @description Summary of Copilot usage.
+ */
+ readonly "copilot-usage-metrics": {
+ /**
+ * Format: date
+ * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format.
+ */
+ readonly day: string;
+ /** @description The total number of Copilot code completion suggestions shown to users. */
+ readonly total_suggestions_count?: number;
+ /** @description The total number of Copilot code completion suggestions accepted by users. */
+ readonly total_acceptances_count?: number;
+ /** @description The total number of lines of code completions suggested by Copilot. */
+ readonly total_lines_suggested?: number;
+ /** @description The total number of lines of code completions accepted by users. */
+ readonly total_lines_accepted?: number;
+ /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */
+ readonly total_active_users?: number;
+ /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */
+ readonly total_chat_acceptances?: number;
+ /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */
+ readonly total_chat_turns?: number;
+ /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */
+ readonly total_active_chat_users?: number;
+ /** @description Breakdown of Copilot code completions usage by language and editor */
+ readonly breakdown: {
+ /** @description The language in which Copilot suggestions were shown to users in the specified editor. */
+ readonly language?: string;
+ /** @description The editor in which Copilot suggestions were shown to users for the specified language. */
+ readonly editor?: string;
+ /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */
+ readonly suggestions_count?: number;
+ /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */
+ readonly acceptances_count?: number;
+ /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */
+ readonly lines_suggested?: number;
+ /** @description The number of lines of code accepted by users in the editor specified during the day specified. */
+ readonly lines_accepted?: number;
+ /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */
+ readonly active_users?: number;
+ readonly [key: string]: unknown;
+ }[] | null;
+ };
/** @description The security alert number. */
readonly "alert-number": number;
/** @description Details for the vulnerable package. */
@@ -19314,6 +20100,7 @@ export interface components {
readonly codespaces?: string[];
readonly copilot?: string[];
readonly packages?: string[];
+ readonly actions?: string[];
};
};
readonly "security-and-analysis": {
@@ -19487,7 +20274,7 @@ export interface components {
readonly forks_count?: number;
readonly stargazers_count?: number;
readonly watchers_count?: number;
- /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */
+ /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */
readonly size?: number;
readonly default_branch?: string;
readonly open_issues_count?: number;
@@ -20122,11 +20909,13 @@ export interface components {
readonly "code-scanning-alert-dismissed-reason": null | "false positive" | "won't fix" | "used in tests";
/** @description The dismissal comment associated with the dismissal of the alert. */
readonly "code-scanning-alert-dismissed-comment": string | null;
- readonly "code-scanning-alert-rule": {
+ readonly "code-scanning-alert-rule-summary": {
/** @description A unique identifier for the rule used to detect the alert. */
readonly id?: string | null;
/** @description The name of the rule used to detect the alert. */
readonly name?: string;
+ /** @description A set of tags applicable for the rule. */
+ readonly tags?: string[] | null;
/**
* @description The severity of the alert.
* @enum {string|null}
@@ -20139,14 +20928,6 @@ export interface components {
readonly security_severity_level?: "low" | "medium" | "high" | "critical";
/** @description A short description of the rule used to detect the alert. */
readonly description?: string;
- /** @description description of the rule used to detect the alert. */
- readonly full_description?: string;
- /** @description A set of tags applicable for the rule. */
- readonly tags?: string[] | null;
- /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */
- readonly help?: string | null;
- /** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
};
/** @description The version of the tool used to generate the code scanning analysis. */
readonly "code-scanning-analysis-tool-version": string | null;
@@ -20206,7 +20987,7 @@ export interface components {
readonly dismissed_at: components["schemas"]["alert-dismissed-at"];
readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"];
readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
- readonly rule: components["schemas"]["code-scanning-alert-rule"];
+ readonly rule: components["schemas"]["code-scanning-alert-rule-summary"];
readonly tool: components["schemas"]["code-scanning-analysis-tool"];
readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
readonly repository: components["schemas"]["simple-repository"];
@@ -20496,7 +21277,17 @@ export interface components {
* @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.
* @enum {string}
*/
- readonly copilot_chat?: "enabled" | "disabled" | "unconfigured";
+ readonly ide_chat?: "enabled" | "disabled" | "unconfigured";
+ /**
+ * @description The organization policy for allowing or disallowing organization members to use Copilot features within github.com.
+ * @enum {string}
+ */
+ readonly platform_chat?: "enabled" | "disabled" | "unconfigured";
+ /**
+ * @description The organization policy for allowing or disallowing organization members to use Copilot within their CLI.
+ * @enum {string}
+ */
+ readonly cli?: "enabled" | "disabled" | "unconfigured";
/**
* @description The mode of assigning new seats.
* @enum {string}
@@ -20902,7 +21693,7 @@ export interface components {
readonly forks_count?: number;
readonly stargazers_count?: number;
readonly watchers_count?: number;
- /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */
+ /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */
readonly size?: number;
readonly default_branch?: string;
readonly open_issues_count?: number;
@@ -21433,11 +22224,18 @@ export interface components {
/** @description Whether the property is required. */
readonly required?: boolean;
/** @description Default value of the property */
- readonly default_value?: string | null;
+ readonly default_value?: (string | string[]) | null;
/** @description Short description of the property */
readonly description?: string | null;
- /** @description Ordered list of allowed values of the property */
+ /** @description An ordered list of the allowed values of the property.
+ * The property can have up to 200 allowed values. */
readonly allowed_values?: string[] | null;
+ /**
+ * @description Who can edit the values of the property
+ * @example org_actors
+ * @enum {string|null}
+ */
+ readonly values_editable_by?: "org_actors" | "org_and_repo_actors";
};
/**
* Custom Property Value
@@ -21447,7 +22245,7 @@ export interface components {
/** @description The name of the property */
readonly property_name: string;
/** @description The value assigned to the property */
- readonly value: string | null;
+ readonly value: (string | string[]) | null;
};
/**
* Organization Repository Custom Property Values
@@ -21464,1150 +22262,395 @@ export interface components {
readonly properties: components["schemas"]["custom-property-value"][];
};
/**
- * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).
- * @enum {string}
- */
- readonly "repository-rule-enforcement": "disabled" | "active" | "evaluate";
- /**
- * Repository Ruleset Bypass Actor
- * @description An actor that can bypass rules in a ruleset
+ * Repository
+ * @description A repository on GitHub.
*/
- readonly "repository-ruleset-bypass-actor": {
- /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */
- readonly actor_id: number;
+ readonly "nullable-repository": {
/**
- * @description The type of actor that can bypass a ruleset
- * @enum {string}
+ * @description Unique identifier of the repository
+ * @example 42
*/
- readonly actor_type: "RepositoryRole" | "Team" | "Integration" | "OrganizationAdmin";
+ readonly id: number;
+ /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ readonly node_id: string;
/**
- * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests.
- * @enum {string}
+ * @description The name of the repository.
+ * @example Team Environment
*/
- readonly bypass_mode: "always" | "pull_request";
- };
- /**
- * Repository ruleset conditions for ref names
- * @description Parameters for a repository ruleset ref name condition
- */
- readonly "repository-ruleset-conditions": {
- readonly ref_name?: {
- /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */
- readonly include?: string[];
- /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */
- readonly exclude?: string[];
- };
- };
- /**
- * Repository ruleset conditions for repository names
- * @description Parameters for a repository name condition
- */
- readonly "repository-ruleset-conditions-repository-name-target": {
- readonly repository_name: {
- /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */
- readonly include?: string[];
- /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */
- readonly exclude?: string[];
- /** @description Whether renaming of target repositories is prevented. */
- readonly protected?: boolean;
- };
- };
- /**
- * Repository ruleset conditions for repository IDs
- * @description Parameters for a repository ID condition
- */
- readonly "repository-ruleset-conditions-repository-id-target": {
- readonly repository_id: {
- /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */
- readonly repository_ids?: number[];
- };
- };
- /**
- * Organization ruleset conditions
- * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.
- *
- */
- readonly "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]);
- /**
- * creation
- * @description Only allow users with bypass permission to create matching refs.
- */
- readonly "repository-rule-creation": {
- /** @enum {string} */
- readonly type: "creation";
- };
- /**
- * update
- * @description Only allow users with bypass permission to update matching refs.
- */
- readonly "repository-rule-update": {
- /** @enum {string} */
- readonly type: "update";
- readonly parameters?: {
- /** @description Branch can pull changes from its upstream repository */
- readonly update_allows_fetch_and_merge: boolean;
- };
- };
- /**
- * deletion
- * @description Only allow users with bypass permissions to delete matching refs.
- */
- readonly "repository-rule-deletion": {
- /** @enum {string} */
- readonly type: "deletion";
- };
- /**
- * required_linear_history
- * @description Prevent merge commits from being pushed to matching refs.
- */
- readonly "repository-rule-required-linear-history": {
- /** @enum {string} */
- readonly type: "required_linear_history";
- };
- /**
- * required_deployments
- * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
- */
- readonly "repository-rule-required-deployments": {
- /** @enum {string} */
- readonly type: "required_deployments";
- readonly parameters?: {
- /** @description The environments that must be successfully deployed to before branches can be merged. */
- readonly required_deployment_environments: string[];
- };
- };
- /**
- * required_signatures
- * @description Commits pushed to matching refs must have verified signatures.
- */
- readonly "repository-rule-required-signatures": {
- /** @enum {string} */
- readonly type: "required_signatures";
- };
- /**
- * pull_request
- * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
- */
- readonly "repository-rule-pull-request": {
- /** @enum {string} */
- readonly type: "pull_request";
- readonly parameters?: {
- /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */
- readonly dismiss_stale_reviews_on_push: boolean;
- /** @description Require an approving review in pull requests that modify files that have a designated code owner. */
- readonly require_code_owner_review: boolean;
- /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */
- readonly require_last_push_approval: boolean;
- /** @description The number of approving reviews that are required before a pull request can be merged. */
- readonly required_approving_review_count: number;
- /** @description All conversations on code must be resolved before a pull request can be merged. */
- readonly required_review_thread_resolution: boolean;
- };
- };
- /**
- * StatusCheckConfiguration
- * @description Required status check
- */
- readonly "repository-rule-params-status-check-configuration": {
- /** @description The status check context name that must be present on the commit. */
- readonly context: string;
- /** @description The optional integration ID that this status check must originate from. */
- readonly integration_id?: number;
- };
- /**
- * required_status_checks
- * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
- */
- readonly "repository-rule-required-status-checks": {
- /** @enum {string} */
- readonly type: "required_status_checks";
- readonly parameters?: {
- /** @description Status checks that are required. */
- readonly required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][];
- /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */
- readonly strict_required_status_checks_policy: boolean;
- };
- };
- /**
- * non_fast_forward
- * @description Prevent users with push access from force pushing to refs.
- */
- readonly "repository-rule-non-fast-forward": {
- /** @enum {string} */
- readonly type: "non_fast_forward";
- };
- /**
- * commit_message_pattern
- * @description Parameters to be used for the commit_message_pattern rule
- */
- readonly "repository-rule-commit-message-pattern": {
- /** @enum {string} */
- readonly type: "commit_message_pattern";
- readonly parameters?: {
- /** @description How this rule will appear to users. */
- readonly name?: string;
- /** @description If true, the rule will fail if the pattern matches. */
- readonly negate?: boolean;
- /**
- * @description The operator to use for matching.
- * @enum {string}
- */
- readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
- /** @description The pattern to match with. */
- readonly pattern: string;
- };
- };
- /**
- * commit_author_email_pattern
- * @description Parameters to be used for the commit_author_email_pattern rule
- */
- readonly "repository-rule-commit-author-email-pattern": {
- /** @enum {string} */
- readonly type: "commit_author_email_pattern";
- readonly parameters?: {
- /** @description How this rule will appear to users. */
- readonly name?: string;
- /** @description If true, the rule will fail if the pattern matches. */
- readonly negate?: boolean;
- /**
- * @description The operator to use for matching.
- * @enum {string}
- */
- readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
- /** @description The pattern to match with. */
- readonly pattern: string;
- };
- };
- /**
- * committer_email_pattern
- * @description Parameters to be used for the committer_email_pattern rule
- */
- readonly "repository-rule-committer-email-pattern": {
- /** @enum {string} */
- readonly type: "committer_email_pattern";
- readonly parameters?: {
- /** @description How this rule will appear to users. */
- readonly name?: string;
- /** @description If true, the rule will fail if the pattern matches. */
- readonly negate?: boolean;
- /**
- * @description The operator to use for matching.
- * @enum {string}
- */
- readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
- /** @description The pattern to match with. */
- readonly pattern: string;
- };
- };
- /**
- * branch_name_pattern
- * @description Parameters to be used for the branch_name_pattern rule
- */
- readonly "repository-rule-branch-name-pattern": {
- /** @enum {string} */
- readonly type: "branch_name_pattern";
- readonly parameters?: {
- /** @description How this rule will appear to users. */
- readonly name?: string;
- /** @description If true, the rule will fail if the pattern matches. */
- readonly negate?: boolean;
- /**
- * @description The operator to use for matching.
- * @enum {string}
- */
- readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
- /** @description The pattern to match with. */
- readonly pattern: string;
- };
- };
- /**
- * tag_name_pattern
- * @description Parameters to be used for the tag_name_pattern rule
- */
- readonly "repository-rule-tag-name-pattern": {
- /** @enum {string} */
- readonly type: "tag_name_pattern";
- readonly parameters?: {
- /** @description How this rule will appear to users. */
- readonly name?: string;
- /** @description If true, the rule will fail if the pattern matches. */
- readonly negate?: boolean;
- /**
- * @description The operator to use for matching.
- * @enum {string}
- */
- readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
- /** @description The pattern to match with. */
- readonly pattern: string;
- };
- };
- /**
- * WorkflowFileReference
- * @description A workflow that must run for this rule to pass
- */
- readonly "repository-rule-params-workflow-file-reference": {
- /** @description The path to the workflow file */
- readonly path: string;
- /** @description The ref (branch or tag) of the workflow file to use */
- readonly ref?: string;
- /** @description The ID of the repository where the workflow is defined */
- readonly repository_id: number;
- /** @description The commit SHA of the workflow file to use */
- readonly sha?: string;
- };
- /**
- * workflows
- * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
- */
- readonly "repository-rule-workflows": {
- /** @enum {string} */
- readonly type: "workflows";
- readonly parameters?: {
- /** @description Workflows that must pass for this rule to pass. */
- readonly workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][];
- };
- };
- /**
- * Repository Rule
- * @description A repository rule.
- */
- readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-workflows"];
- /**
- * Repository ruleset
- * @description A set of rules to apply when specified conditions are met.
- */
- readonly "repository-ruleset": {
- /** @description The ID of the ruleset */
- readonly id: number;
- /** @description The name of the ruleset */
readonly name: string;
+ /** @example octocat/Hello-World */
+ readonly full_name: string;
+ readonly license: components["schemas"]["nullable-license-simple"];
+ readonly forks: number;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly pull: boolean;
+ readonly triage?: boolean;
+ readonly push: boolean;
+ readonly maintain?: boolean;
+ };
+ readonly owner: components["schemas"]["simple-user"];
/**
- * @description The target of the ruleset
- * @enum {string}
+ * @description Whether the repository is private or public.
+ * @default false
*/
- readonly target?: "branch" | "tag";
+ readonly private: boolean;
/**
- * @description The type of the source of the ruleset
- * @enum {string}
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World
*/
- readonly source_type?: "Repository" | "Organization";
- /** @description The name of the source */
- readonly source: string;
- readonly enforcement: components["schemas"]["repository-rule-enforcement"];
- /** @description The actors that can bypass the rules in this ruleset */
- readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][];
+ readonly html_url: string;
+ /** @example This your first repo! */
+ readonly description: string | null;
+ readonly fork: boolean;
/**
- * @description The bypass type of the user making the API request for this ruleset. This field is only returned when
- * querying the repository-level endpoint.
- * @enum {string}
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World
*/
- readonly current_user_can_bypass?: "always" | "pull_requests_only" | "never";
- readonly node_id?: string;
- readonly _links?: {
- readonly self?: {
- /** @description The URL of the ruleset */
- readonly href?: string;
- };
- readonly html?: {
- /** @description The html URL of the ruleset */
- readonly href?: string;
- };
- };
- readonly conditions?: components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"];
- readonly rules?: components["schemas"]["repository-rule"][];
- /** Format: date-time */
- readonly created_at?: string;
- /** Format: date-time */
- readonly updated_at?: string;
- };
- /**
- * Rule Suites
- * @description Response
- */
- readonly "rule-suites": {
- /** @description The unique identifier of the rule insight. */
- readonly id?: number;
- /** @description The number that identifies the user. */
- readonly actor_id?: number;
- /** @description The handle for the GitHub user account. */
- readonly actor_name?: string;
- /** @description The first commit sha before the push evaluation. */
- readonly before_sha?: string;
- /** @description The last commit sha in the push evaluation. */
- readonly after_sha?: string;
- /** @description The ref name that the evaluation ran on. */
- readonly ref?: string;
- /** @description The ID of the repository associated with the rule evaluation. */
- readonly repository_id?: number;
- /** @description The name of the repository without the `.git` extension. */
- readonly repository_name?: string;
+ readonly url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
+ readonly archive_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
+ readonly assignees_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
+ readonly blobs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
+ readonly branches_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
+ readonly collaborators_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
+ readonly comments_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
+ readonly commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
+ readonly compare_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
+ readonly contents_url: string;
/**
- * Format: date-time
- * @example 2011-01-26T19:06:43Z
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/contributors
*/
- readonly pushed_at?: string;
+ readonly contributors_url: string;
/**
- * @description The result of the rule evaluations for rules with the `active` enforcement status.
- * @enum {string}
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/deployments
*/
- readonly result?: "pass" | "fail" | "bypass";
+ readonly deployments_url: string;
/**
- * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`.
- * @enum {string}
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/downloads
*/
- readonly evaluation_result?: "pass" | "fail";
- }[];
- /**
- * Rule Suite
- * @description Response
- */
- readonly "rule-suite": {
- /** @description The unique identifier of the rule insight. */
- readonly id?: number;
- /** @description The number that identifies the user. */
- readonly actor_id?: number;
- /** @description The handle for the GitHub user account. */
- readonly actor_name?: string;
- /** @description The first commit sha before the push evaluation. */
- readonly before_sha?: string;
- /** @description The last commit sha in the push evaluation. */
- readonly after_sha?: string;
- /** @description The ref name that the evaluation ran on. */
- readonly ref?: string;
- /** @description The ID of the repository associated with the rule evaluation. */
- readonly repository_id?: number;
- /** @description The name of the repository without the `.git` extension. */
- readonly repository_name?: string;
+ readonly downloads_url: string;
/**
- * Format: date-time
- * @example 2011-01-26T19:06:43Z
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/events
*/
- readonly pushed_at?: string;
+ readonly events_url: string;
/**
- * @description The result of the rule evaluations for rules with the `active` enforcement status.
- * @enum {string}
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/forks
*/
- readonly result?: "pass" | "fail" | "bypass";
- /**
- * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`.
- * @enum {string}
- */
- readonly evaluation_result?: "pass" | "fail";
- /** @description Details on the evaluated rules. */
- readonly rule_evaluations?: {
- readonly rule_source?: {
- /** @description The type of rule source. */
- readonly type?: string;
- /** @description The ID of the rule source. */
- readonly id?: number | null;
- /** @description The name of the rule source. */
- readonly name?: string | null;
- };
- /**
- * @description The enforcement level of this rule source.
- * @enum {string}
- */
- readonly enforcement?: "active" | "evaluate" | "deleted ruleset";
- /**
- * @description The result of the evaluation of the individual rule.
- * @enum {string}
- */
- readonly result?: "pass" | "fail";
- /** @description The type of rule. */
- readonly rule_type?: string;
- /** @description Any associated details with the rule evaluation. */
- readonly details?: string;
- }[];
- };
- /** @description A product affected by the vulnerability detailed in a repository security advisory. */
- readonly "repository-advisory-vulnerability": {
- /** @description The name of the package affected by the vulnerability. */
- readonly package: {
- readonly ecosystem: components["schemas"]["security-advisory-ecosystems"];
- /** @description The unique package name within its ecosystem. */
- readonly name: string | null;
- } | null;
- /** @description The range of the package versions affected by the vulnerability. */
- readonly vulnerable_version_range: string | null;
- /** @description The package version(s) that resolve the vulnerability. */
- readonly patched_versions: string | null;
- /** @description The functions in the package that are affected. */
- readonly vulnerable_functions: string[] | null;
- };
- /** @description A credit given to a user for a repository security advisory. */
- readonly "repository-advisory-credit": {
- readonly user: components["schemas"]["simple-user"];
- readonly type: components["schemas"]["security-advisory-credit-types"];
- /**
- * @description The state of the user's acceptance of the credit.
- * @enum {string}
- */
- readonly state: "accepted" | "declined" | "pending";
- };
- /** @description A repository security advisory. */
- readonly "repository-advisory": {
- /** @description The GitHub Security Advisory ID. */
- readonly ghsa_id: string;
- /** @description The Common Vulnerabilities and Exposures (CVE) ID. */
- readonly cve_id: string | null;
+ readonly forks_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
+ readonly git_commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
+ readonly git_refs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
+ readonly git_tags_url: string;
+ /** @example git:github.com/octocat/Hello-World.git */
+ readonly git_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
+ readonly issue_comment_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
+ readonly issue_events_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
+ readonly issues_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
+ readonly keys_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
+ readonly labels_url: string;
/**
* Format: uri
- * @description The API URL for the advisory.
+ * @example http://api.github.com/repos/octocat/Hello-World/languages
*/
- readonly url: string;
+ readonly languages_url: string;
/**
* Format: uri
- * @description The URL for the advisory.
- */
- readonly html_url: string;
- /** @description A short summary of the advisory. */
- readonly summary: string;
- /** @description A detailed description of what the advisory entails. */
- readonly description: string | null;
- /**
- * @description The severity of the advisory.
- * @enum {string|null}
+ * @example http://api.github.com/repos/octocat/Hello-World/merges
*/
- readonly severity: "critical" | "high" | "medium" | "low";
- /** @description The author of the advisory. */
- readonly author: components["schemas"]["simple-user"] | null;
- /** @description The publisher of the advisory. */
- readonly publisher: components["schemas"]["simple-user"] | null;
- readonly identifiers: {
- /**
- * @description The type of identifier.
- * @enum {string}
- */
- readonly type: "CVE" | "GHSA";
- /** @description The identifier value. */
- readonly value: string;
- }[];
+ readonly merges_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
+ readonly milestones_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
+ readonly notifications_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
+ readonly pulls_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
+ readonly releases_url: string;
+ /** @example git@github.com:octocat/Hello-World.git */
+ readonly ssh_url: string;
/**
- * @description The state of the advisory.
- * @enum {string}
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/stargazers
*/
- readonly state: "published" | "closed" | "withdrawn" | "draft" | "triage";
+ readonly stargazers_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
+ readonly statuses_url: string;
/**
- * Format: date-time
- * @description The date and time of when the advisory was created, in ISO 8601 format.
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscribers
*/
- readonly created_at: string | null;
+ readonly subscribers_url: string;
/**
- * Format: date-time
- * @description The date and time of when the advisory was last updated, in ISO 8601 format.
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscription
*/
- readonly updated_at: string | null;
+ readonly subscription_url: string;
/**
- * Format: date-time
- * @description The date and time of when the advisory was published, in ISO 8601 format.
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/tags
*/
- readonly published_at: string | null;
+ readonly tags_url: string;
/**
- * Format: date-time
- * @description The date and time of when the advisory was closed, in ISO 8601 format.
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/teams
*/
- readonly closed_at: string | null;
+ readonly teams_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
+ readonly trees_url: string;
+ /** @example https://github.com/octocat/Hello-World.git */
+ readonly clone_url: string;
/**
- * Format: date-time
- * @description The date and time of when the advisory was withdrawn, in ISO 8601 format.
+ * Format: uri
+ * @example git:git.example.com/octocat/Hello-World
*/
- readonly withdrawn_at: string | null;
- readonly submission: {
- /** @description Whether a private vulnerability report was accepted by the repository's administrators. */
- readonly accepted: boolean;
- } | null;
- readonly vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null;
- readonly cvss: {
- /** @description The CVSS vector. */
- readonly vector_string: string | null;
- /** @description The CVSS score. */
- readonly score: number | null;
- } | null;
- readonly cwes: {
- /** @description The Common Weakness Enumeration (CWE) identifier. */
- readonly cwe_id: string;
- /** @description The name of the CWE. */
- readonly name: string;
- }[] | null;
- /** @description A list of only the CWE IDs. */
- readonly cwe_ids: string[] | null;
- readonly credits: {
- /** @description The username of the user credited. */
- readonly login?: string;
- readonly type?: components["schemas"]["security-advisory-credit-types"];
- }[] | null;
- readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null;
- /** @description A list of users that collaborate on the advisory. */
- readonly collaborating_users: components["schemas"]["simple-user"][] | null;
- /** @description A list of teams that collaborate on the advisory. */
- readonly collaborating_teams: components["schemas"]["team"][] | null;
- /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */
- readonly private_fork: components["schemas"]["simple-repository"] | null;
- };
- /**
- * Team Simple
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly "team-simple": {
+ readonly mirror_url: string | null;
/**
- * @description Unique identifier of the team
- * @example 1
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/hooks
*/
- readonly id: number;
- /** @example MDQ6VGVhbTE= */
- readonly node_id: string;
+ readonly hooks_url: string;
/**
* Format: uri
- * @description URL for the team
- * @example https://api.github.com/organizations/1/team/1
+ * @example https://svn.github.com/octocat/Hello-World
*/
- readonly url: string;
- /** @example https://api.github.com/organizations/1/team/1/members{/member} */
- readonly members_url: string;
+ readonly svn_url: string;
/**
- * @description Name of the team
- * @example Justice League
+ * Format: uri
+ * @example https://github.com
*/
- readonly name: string;
+ readonly homepage: string | null;
+ readonly language: string | null;
+ /** @example 9 */
+ readonly forks_count: number;
+ /** @example 80 */
+ readonly stargazers_count: number;
+ /** @example 80 */
+ readonly watchers_count: number;
/**
- * @description Description of the team
- * @example A great team.
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @example 108
*/
- readonly description: string | null;
+ readonly size: number;
/**
- * @description Permission that the team will have for its repositories
- * @example admin
+ * @description The default branch of the repository.
+ * @example master
*/
- readonly permission: string;
+ readonly default_branch: string;
+ /** @example 0 */
+ readonly open_issues_count: number;
/**
- * @description The level of privacy this team should have
- * @example closed
+ * @description Whether this repository acts as a template that can be used to generate new repositories.
+ * @default false
+ * @example true
*/
- readonly privacy?: string;
+ readonly is_template: boolean;
+ readonly topics?: string[];
/**
- * @description The notification setting the team has set
- * @example notifications_enabled
+ * @description Whether issues are enabled.
+ * @default true
+ * @example true
*/
- readonly notification_setting?: string;
+ readonly has_issues: boolean;
/**
- * Format: uri
- * @example https://github.com/orgs/rails/teams/core
+ * @description Whether projects are enabled.
+ * @default true
+ * @example true
*/
- readonly html_url: string;
+ readonly has_projects: boolean;
/**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/1/repos
+ * @description Whether the wiki is enabled.
+ * @default true
+ * @example true
*/
- readonly repositories_url: string;
- /** @example justice-league */
- readonly slug: string;
+ readonly has_wiki: boolean;
+ readonly has_pages: boolean;
/**
- * @description Distinguished Name (DN) that team maps to within LDAP environment
- * @example uid=example,ou=users,dc=github,dc=com
+ * @deprecated
+ * @description Whether downloads are enabled.
+ * @default true
+ * @example true
*/
- readonly ldap_dn?: string;
- };
- readonly "actions-billing-usage": {
- /** @description The sum of the free and paid GitHub Actions minutes used. */
- readonly total_minutes_used: number;
- /** @description The total paid GitHub Actions minutes used. */
- readonly total_paid_minutes_used: number;
- /** @description The amount of free GitHub Actions minutes available. */
- readonly included_minutes: number;
- readonly minutes_used_breakdown: {
- /** @description Total minutes used on Ubuntu runner machines. */
- readonly UBUNTU?: number;
- /** @description Total minutes used on macOS runner machines. */
- readonly MACOS?: number;
- /** @description Total minutes used on Windows runner machines. */
- readonly WINDOWS?: number;
- /** @description Total minutes used on Ubuntu 4 core runner machines. */
- readonly ubuntu_4_core?: number;
- /** @description Total minutes used on Ubuntu 8 core runner machines. */
- readonly ubuntu_8_core?: number;
- /** @description Total minutes used on Ubuntu 16 core runner machines. */
- readonly ubuntu_16_core?: number;
- /** @description Total minutes used on Ubuntu 32 core runner machines. */
- readonly ubuntu_32_core?: number;
- /** @description Total minutes used on Ubuntu 64 core runner machines. */
- readonly ubuntu_64_core?: number;
- /** @description Total minutes used on Windows 4 core runner machines. */
- readonly windows_4_core?: number;
- /** @description Total minutes used on Windows 8 core runner machines. */
- readonly windows_8_core?: number;
- /** @description Total minutes used on Windows 16 core runner machines. */
- readonly windows_16_core?: number;
- /** @description Total minutes used on Windows 32 core runner machines. */
- readonly windows_32_core?: number;
- /** @description Total minutes used on Windows 64 core runner machines. */
- readonly windows_64_core?: number;
- /** @description Total minutes used on macOS 12 core runner machines. */
- readonly macos_12_core?: number;
- /** @description Total minutes used on all runner machines. */
- readonly total?: number;
- };
- };
- readonly "packages-billing-usage": {
- /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */
- readonly total_gigabytes_bandwidth_used: number;
- /** @description Total paid storage space (GB) for GitHuub Packages. */
- readonly total_paid_gigabytes_bandwidth_used: number;
- /** @description Free storage space (GB) for GitHub Packages. */
- readonly included_gigabytes_bandwidth: number;
- };
- readonly "combined-billing-usage": {
- /** @description Numbers of days left in billing cycle. */
- readonly days_left_in_billing_cycle: number;
- /** @description Estimated storage space (GB) used in billing cycle. */
- readonly estimated_paid_storage_for_month: number;
- /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */
- readonly estimated_storage_for_month: number;
- };
- /**
- * Team Organization
- * @description Team Organization
- */
- readonly "team-organization": {
- /** @example github */
- readonly login: string;
- /** @example 1 */
- readonly id: number;
- /** @example MDEyOk9yZ2FuaXphdGlvbjE= */
- readonly node_id: string;
+ readonly has_downloads: boolean;
/**
- * Format: uri
- * @example https://api.github.com/orgs/github
+ * @description Whether discussions are enabled.
+ * @default false
+ * @example true
*/
- readonly url: string;
+ readonly has_discussions: boolean;
/**
- * Format: uri
- * @example https://api.github.com/orgs/github/repos
+ * @description Whether the repository is archived.
+ * @default false
*/
- readonly repos_url: string;
+ readonly archived: boolean;
+ /** @description Returns whether or not this repository disabled. */
+ readonly disabled: boolean;
/**
- * Format: uri
- * @example https://api.github.com/orgs/github/events
+ * @description The repository visibility: public, private, or internal.
+ * @default public
*/
- readonly events_url: string;
- /** @example https://api.github.com/orgs/github/hooks */
- readonly hooks_url: string;
- /** @example https://api.github.com/orgs/github/issues */
- readonly issues_url: string;
- /** @example https://api.github.com/orgs/github/members{/member} */
- readonly members_url: string;
- /** @example https://api.github.com/orgs/github/public_members{/member} */
- readonly public_members_url: string;
- /** @example https://github.com/images/error/octocat_happy.gif */
- readonly avatar_url: string;
- /** @example A great organization */
- readonly description: string | null;
- /** @example github */
- readonly name?: string;
- /** @example GitHub */
- readonly company?: string;
+ readonly visibility: string;
/**
- * Format: uri
- * @example https://github.com/blog
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
*/
- readonly blog?: string;
- /** @example San Francisco */
- readonly location?: string;
+ readonly pushed_at: string | null;
/**
- * Format: email
- * @example octocat@github.com
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
*/
- readonly email?: string;
- /** @example github */
- readonly twitter_username?: string | null;
- /** @example true */
- readonly is_verified?: boolean;
- /** @example true */
- readonly has_organization_projects: boolean;
- /** @example true */
- readonly has_repository_projects: boolean;
- /** @example 2 */
- readonly public_repos: number;
- /** @example 1 */
- readonly public_gists: number;
- /** @example 20 */
- readonly followers: number;
- /** @example 0 */
- readonly following: number;
+ readonly created_at: string | null;
/**
- * Format: uri
- * @example https://github.com/octocat
+ * Format: date-time
+ * @example 2011-01-26T19:14:43Z
*/
- readonly html_url: string;
+ readonly updated_at: string | null;
/**
- * Format: date-time
- * @example 2008-01-14T04:33:35Z
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ * @example true
*/
- readonly created_at: string;
- /** @example Organization */
- readonly type: string;
- /** @example 100 */
- readonly total_private_repos?: number;
- /** @example 100 */
- readonly owned_private_repos?: number;
- /** @example 81 */
- readonly private_gists?: number | null;
- /** @example 10000 */
- readonly disk_usage?: number | null;
- /** @example 8 */
- readonly collaborators?: number | null;
+ readonly allow_rebase_merge: boolean;
+ readonly temp_clone_token?: string;
/**
- * Format: email
- * @example org@example.com
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ * @example true
*/
- readonly billing_email?: string | null;
- readonly plan?: {
- readonly name: string;
- readonly space: number;
- readonly private_repos: number;
- readonly filled_seats?: number;
- readonly seats?: number;
- };
- readonly default_repository_permission?: string | null;
- /** @example true */
- readonly members_can_create_repositories?: boolean | null;
- /** @example true */
- readonly two_factor_requirement_enabled?: boolean | null;
- /** @example all */
- readonly members_allowed_repository_creation_type?: string;
- /** @example true */
- readonly members_can_create_public_repositories?: boolean;
- /** @example true */
- readonly members_can_create_private_repositories?: boolean;
- /** @example true */
- readonly members_can_create_internal_repositories?: boolean;
- /** @example true */
- readonly members_can_create_pages?: boolean;
- /** @example true */
- readonly members_can_create_public_pages?: boolean;
- /** @example true */
- readonly members_can_create_private_pages?: boolean;
- /** @example false */
- readonly members_can_fork_private_repositories?: boolean | null;
- /** @example false */
- readonly web_commit_signoff_required?: boolean;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: date-time */
- readonly archived_at: string | null;
- };
- /**
- * Full Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly "team-full": {
+ readonly allow_squash_merge: boolean;
/**
- * @description Unique identifier of the team
- * @example 42
+ * @description Whether to allow Auto-merge to be used on pull requests.
+ * @default false
+ * @example false
*/
- readonly id: number;
- /** @example MDQ6VGVhbTE= */
- readonly node_id: string;
+ readonly allow_auto_merge: boolean;
/**
- * Format: uri
- * @description URL for the team
- * @example https://api.github.com/organizations/1/team/1
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ * @example false
*/
- readonly url: string;
+ readonly delete_branch_on_merge: boolean;
/**
- * Format: uri
- * @example https://github.com/orgs/rails/teams/core
+ * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
+ * @default false
+ * @example false
*/
- readonly html_url: string;
+ readonly allow_update_branch: boolean;
/**
- * @description Name of the team
- * @example Developers
+ * @deprecated
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
*/
- readonly name: string;
- /** @example justice-league */
- readonly slug: string;
- /** @example A great team. */
- readonly description: string | null;
+ readonly use_squash_pr_title_as_default: boolean;
/**
- * @description The level of privacy this team should have
- * @example closed
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
* @enum {string}
*/
- readonly privacy?: "closed" | "secret";
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
- * @description The notification setting the team has set
- * @example notifications_enabled
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /**
- * @description Permission that the team will have for its repositories
- * @example push
- */
- readonly permission: string;
- /** @example https://api.github.com/organizations/1/team/1/members{/member} */
- readonly members_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/1/repos
- */
- readonly repositories_url: string;
- readonly parent?: components["schemas"]["nullable-team-simple"];
- /** @example 3 */
- readonly members_count: number;
- /** @example 10 */
- readonly repos_count: number;
- /**
- * Format: date-time
- * @example 2017-07-14T16:53:42Z
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @example 2017-08-17T12:37:15Z
- */
- readonly updated_at: string;
- readonly organization: components["schemas"]["team-organization"];
- /**
- * @description Distinguished Name (DN) that team maps to within LDAP environment
- * @example uid=example,ou=users,dc=github,dc=com
- */
- readonly ldap_dn?: string;
- };
- /**
- * Team Discussion
- * @description A team discussion is a persistent record of a free-form conversation within a team.
- */
- readonly "team-discussion": {
- readonly author: components["schemas"]["nullable-simple-user"];
- /**
- * @description The main text of the discussion.
- * @example Please suggest improvements to our workflow in comments.
- */
- readonly body: string;
- /** @example Hi! This is an area for us to collaborate as a team
*/
- readonly body_html: string;
- /**
- * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
- * @example 0307116bbf7ced493b8d8a346c650b71
- */
- readonly body_version: string;
- /** @example 0 */
- readonly comments_count: number;
- /**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments
- */
- readonly comments_url: string;
- /**
- * Format: date-time
- * @example 2018-01-25T18:56:31Z
- */
- readonly created_at: string;
- /** Format: date-time */
- readonly last_edited_at: string | null;
- /**
- * Format: uri
- * @example https://github.com/orgs/github/teams/justice-league/discussions/1
- */
- readonly html_url: string;
- /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */
- readonly node_id: string;
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
- * @description The unique sequence number of a team discussion.
- * @example 42
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
*/
- readonly number: number;
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
- * @description Whether or not this discussion should be pinned for easy retrieval.
- * @example true
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
*/
- readonly pinned: boolean;
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
- * @description Whether or not this discussion should be restricted to team members and organization owners.
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
* @example true
*/
- readonly private: boolean;
- /**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2343027
- */
- readonly team_url: string;
- /**
- * @description The title of the discussion.
- * @example How can we improve our workflow?
- */
- readonly title: string;
- /**
- * Format: date-time
- * @example 2018-01-25T18:56:31Z
- */
- readonly updated_at: string;
+ readonly allow_merge_commit: boolean;
+ /** @description Whether to allow forking this repo */
+ readonly allow_forking?: boolean;
/**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2343027/discussions/1
+ * @description Whether to require contributors to sign off on web-based commits
+ * @default false
*/
- readonly url: string;
- readonly reactions?: components["schemas"]["reaction-rollup"];
- };
+ readonly web_commit_signoff_required: boolean;
+ readonly open_issues: number;
+ readonly watchers: number;
+ readonly master_branch?: string;
+ /** @example "2020-07-09T00:17:42Z" */
+ readonly starred_at?: string;
+ /** @description Whether anonymous git access is enabled for this repository */
+ readonly anonymous_access_enabled?: boolean;
+ } | null;
/**
- * Team Discussion Comment
- * @description A reply to a discussion within a team.
+ * Code Of Conduct Simple
+ * @description Code of Conduct Simple
*/
- readonly "team-discussion-comment": {
- readonly author: components["schemas"]["nullable-simple-user"];
- /**
- * @description The main text of the comment.
- * @example I agree with this suggestion.
- */
- readonly body: string;
- /** @example Do you like apples?
*/
- readonly body_html: string;
- /**
- * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
- * @example 0307116bbf7ced493b8d8a346c650b71
- */
- readonly body_version: string;
- /**
- * Format: date-time
- * @example 2018-01-15T23:53:58Z
- */
- readonly created_at: string;
- /** Format: date-time */
- readonly last_edited_at: string | null;
- /**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2403582/discussions/1
- */
- readonly discussion_url: string;
- /**
- * Format: uri
- * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- */
- readonly html_url: string;
- /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */
- readonly node_id: string;
- /**
- * @description The unique sequence number of a team discussion comment.
- * @example 42
- */
- readonly number: number;
- /**
- * Format: date-time
- * @example 2018-01-15T23:53:58Z
- */
- readonly updated_at: string;
+ readonly "code-of-conduct-simple": {
/**
* Format: uri
- * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- */
- readonly url: string;
- readonly reactions?: components["schemas"]["reaction-rollup"];
- };
- /**
- * Reaction
- * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively.
- */
- readonly reaction: {
- /** @example 1 */
- readonly id: number;
- /** @example MDg6UmVhY3Rpb24x */
- readonly node_id: string;
- readonly user: components["schemas"]["nullable-simple-user"];
- /**
- * @description The reaction to use
- * @example heart
- * @enum {string}
- */
- readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
- /**
- * Format: date-time
- * @example 2016-05-20T20:09:31Z
+ * @example https://api.github.com/repos/github/docs/community/code_of_conduct
*/
- readonly created_at: string;
- };
- /**
- * Team Membership
- * @description Team Membership
- */
- readonly "team-membership": {
- /** Format: uri */
readonly url: string;
+ /** @example citizen_code_of_conduct */
+ readonly key: string;
+ /** @example Citizen Code of Conduct */
+ readonly name: string;
/**
- * @description The role of the user in the team.
- * @default member
- * @example member
- * @enum {string}
- */
- readonly role: "member" | "maintainer";
- /**
- * @description The state of the user's membership in the team.
- * @enum {string}
+ * Format: uri
+ * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
*/
- readonly state: "active" | "pending";
- };
- /**
- * Team Project
- * @description A team's access to a project.
- */
- readonly "team-project": {
- readonly owner_url: string;
- readonly url: string;
- readonly html_url: string;
- readonly columns_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly name: string;
- readonly body: string | null;
- readonly number: number;
- readonly state: string;
- readonly creator: components["schemas"]["simple-user"];
- readonly created_at: string;
- readonly updated_at: string;
- /** @description The organization permission for this project. Only present when owner is an organization. */
- readonly organization_permission?: string;
- /** @description Whether the project is private or not. Only present when owner is an organization. */
- readonly private?: boolean;
- readonly permissions: {
- readonly read: boolean;
- readonly write: boolean;
- readonly admin: boolean;
- };
+ readonly html_url: string | null;
};
/**
- * Team Repository
- * @description A team's access to a repository.
+ * Full Repository
+ * @description Full Repository
*/
- readonly "team-repository": {
- /**
- * @description Unique identifier of the repository
- * @example 42
- */
+ readonly "full-repository": {
+ /** @example 1296269 */
readonly id: number;
/** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
readonly node_id: string;
- /**
- * @description The name of the repository.
- * @example Team Environment
- */
+ /** @example Hello-World */
readonly name: string;
/** @example octocat/Hello-World */
readonly full_name: string;
- readonly license: components["schemas"]["nullable-license-simple"];
- readonly forks: number;
- readonly permissions?: {
- readonly admin: boolean;
- readonly pull: boolean;
- readonly triage?: boolean;
- readonly push: boolean;
- readonly maintain?: boolean;
- };
- /** @example admin */
- readonly role_name?: string;
- readonly owner: components["schemas"]["nullable-simple-user"];
- /**
- * @description Whether the repository is private or public.
- * @default false
- */
+ readonly owner: components["schemas"]["simple-user"];
readonly private: boolean;
/**
* Format: uri
@@ -22761,790 +22804,1375 @@ export interface components {
readonly stargazers_count: number;
/** @example 80 */
readonly watchers_count: number;
- /** @example 108 */
- readonly size: number;
/**
- * @description The default branch of the repository.
- * @example master
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @example 108
*/
+ readonly size: number;
+ /** @example master */
readonly default_branch: string;
/** @example 0 */
readonly open_issues_count: number;
- /**
- * @description Whether this repository acts as a template that can be used to generate new repositories.
- * @default false
- * @example true
- */
- readonly is_template: boolean;
+ /** @example true */
+ readonly is_template?: boolean;
+ /** @example [
+ * "octocat",
+ * "atom",
+ * "electron",
+ * "API"
+ * ] */
readonly topics?: string[];
- /**
- * @description Whether issues are enabled.
- * @default true
- * @example true
- */
+ /** @example true */
readonly has_issues: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- * @example true
- */
+ /** @example true */
readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- * @example true
- */
+ /** @example true */
readonly has_wiki: boolean;
readonly has_pages: boolean;
- /**
- * @description Whether downloads are enabled.
- * @default true
- * @example true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
+ /** @example true */
+ readonly has_downloads?: boolean;
+ /** @example true */
+ readonly has_discussions: boolean;
readonly archived: boolean;
/** @description Returns whether or not this repository disabled. */
readonly disabled: boolean;
/**
* @description The repository visibility: public, private, or internal.
- * @default public
+ * @example public
*/
- readonly visibility: string;
+ readonly visibility?: string;
/**
* Format: date-time
* @example 2011-01-26T19:06:43Z
*/
- readonly pushed_at: string | null;
+ readonly pushed_at: string;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- readonly created_at: string | null;
+ readonly created_at: string;
/**
* Format: date-time
* @example 2011-01-26T19:14:43Z
*/
- readonly updated_at: string | null;
+ readonly updated_at: string;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
+ readonly pull: boolean;
+ };
+ /** @example true */
+ readonly allow_rebase_merge?: boolean;
+ readonly template_repository?: components["schemas"]["nullable-repository"];
+ readonly temp_clone_token?: string | null;
+ /** @example true */
+ readonly allow_squash_merge?: boolean;
+ /** @example false */
+ readonly allow_auto_merge?: boolean;
+ /** @example false */
+ readonly delete_branch_on_merge?: boolean;
+ /** @example true */
+ readonly allow_merge_commit?: boolean;
+ /** @example true */
+ readonly allow_update_branch?: boolean;
+ /** @example false */
+ readonly use_squash_pr_title_as_default?: boolean;
/**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- * @example true
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @example PR_TITLE
+ * @enum {string}
*/
- readonly allow_rebase_merge: boolean;
- readonly temp_clone_token?: string;
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- * @example true
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @example PR_BODY
+ * @enum {string}
*/
- readonly allow_squash_merge: boolean;
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
- * @description Whether to allow Auto-merge to be used on pull requests.
- * @default false
- * @example false
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @example PR_TITLE
+ * @enum {string}
*/
- readonly allow_auto_merge: boolean;
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- * @example false
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @example PR_BODY
+ * @enum {string}
*/
- readonly delete_branch_on_merge: boolean;
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /** @example true */
+ readonly allow_forking?: boolean;
+ /** @example false */
+ readonly web_commit_signoff_required?: boolean;
+ /** @example 42 */
+ readonly subscribers_count: number;
+ /** @example 0 */
+ readonly network_count: number;
+ readonly license: components["schemas"]["nullable-license-simple"];
+ readonly organization?: components["schemas"]["nullable-simple-user"];
+ readonly parent?: components["schemas"]["repository"];
+ readonly source?: components["schemas"]["repository"];
+ readonly forks: number;
+ readonly master_branch?: string;
+ readonly open_issues: number;
+ readonly watchers: number;
/**
- * @description Whether to allow merge commits for pull requests.
+ * @description Whether anonymous git access is allowed.
* @default true
- * @example true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow forking this repo
- * @default false
- * @example false
*/
- readonly allow_forking: boolean;
- /**
- * @description Whether to require contributors to sign off on web-based commits
- * @default false
- * @example false
- */
- readonly web_commit_signoff_required: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
- readonly open_issues: number;
- readonly watchers: number;
- readonly master_branch?: string;
+ readonly anonymous_access_enabled: boolean;
+ readonly code_of_conduct?: components["schemas"]["code-of-conduct-simple"];
+ readonly security_and_analysis?: components["schemas"]["security-and-analysis"];
+ /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
+ readonly custom_properties?: {
+ readonly [key: string]: unknown;
+ };
};
/**
- * Project Card
- * @description Project cards represent a scope of work.
+ * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).
+ * @enum {string}
*/
- readonly "project-card": {
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/cards/1478
- */
- readonly url: string;
- /**
- * @description The project card's ID
- * @example 42
- */
- readonly id: number;
- /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */
- readonly node_id: string;
- /** @example Add payload for delete Project column */
- readonly note: string | null;
- readonly creator: components["schemas"]["nullable-simple-user"];
+ readonly "repository-rule-enforcement": "disabled" | "active" | "evaluate";
+ /**
+ * Repository Ruleset Bypass Actor
+ * @description An actor that can bypass rules in a ruleset
+ */
+ readonly "repository-ruleset-bypass-actor": {
+ /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.
+ * */
+ readonly actor_id?: number | null;
/**
- * Format: date-time
- * @example 2016-09-05T14:21:06Z
+ * @description The type of actor that can bypass a ruleset.
+ *
+ * @enum {string}
*/
- readonly created_at: string;
+ readonly actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey";
/**
- * Format: date-time
- * @example 2016-09-05T14:20:22Z
+ * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.
+ *
+ * @enum {string}
*/
- readonly updated_at: string;
- /**
- * @description Whether or not the card is archived
- * @example false
- */
- readonly archived?: boolean;
- readonly column_name?: string;
- readonly project_id?: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/367
- */
- readonly column_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/repos/api-playground/projects-test/issues/3
- */
- readonly content_url?: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/120
- */
- readonly project_url: string;
+ readonly bypass_mode: "always" | "pull_request";
};
/**
- * Project Column
- * @description Project columns contain cards of work.
+ * Repository ruleset conditions for ref names
+ * @description Parameters for a repository ruleset ref name condition
*/
- readonly "project-column": {
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/367
- */
- readonly url: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/120
- */
- readonly project_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/367/cards
- */
- readonly cards_url: string;
- /**
- * @description The unique identifier of the project column
- * @example 42
- */
- readonly id: number;
- /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */
- readonly node_id: string;
- /**
- * @description Name of the project column
- * @example Remaining tasks
- */
+ readonly "repository-ruleset-conditions": {
+ readonly ref_name?: {
+ /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */
+ readonly include?: string[];
+ /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */
+ readonly exclude?: string[];
+ };
+ };
+ /**
+ * Repository ruleset conditions for repository names
+ * @description Parameters for a repository name condition
+ */
+ readonly "repository-ruleset-conditions-repository-name-target": {
+ readonly repository_name: {
+ /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */
+ readonly include?: string[];
+ /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */
+ readonly exclude?: string[];
+ /** @description Whether renaming of target repositories is prevented. */
+ readonly protected?: boolean;
+ };
+ };
+ /**
+ * Repository ruleset conditions for repository IDs
+ * @description Parameters for a repository ID condition
+ */
+ readonly "repository-ruleset-conditions-repository-id-target": {
+ readonly repository_id: {
+ /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */
+ readonly repository_ids?: number[];
+ };
+ };
+ /**
+ * Repository ruleset property targeting definition
+ * @description Parameters for a targeting a repository property
+ */
+ readonly "repository-ruleset-conditions-repository-property-spec": {
+ /** @description The name of the repository property to target */
readonly name: string;
- /**
- * Format: date-time
- * @example 2016-09-05T14:18:44Z
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @example 2016-09-05T14:22:28Z
- */
- readonly updated_at: string;
+ /** @description The values to match for the repository property */
+ readonly property_values: string[];
};
/**
- * Project Collaborator Permission
- * @description Project Collaborator Permission
+ * Repository ruleset conditions for repository properties
+ * @description Parameters for a repository property condition
*/
- readonly "project-collaborator-permission": {
- readonly permission: string;
- readonly user: components["schemas"]["nullable-simple-user"];
+ readonly "repository-ruleset-conditions-repository-property-target": {
+ readonly repository_property: {
+ /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */
+ readonly include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][];
+ /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */
+ readonly exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][];
+ };
};
- /** Rate Limit */
- readonly "rate-limit": {
- readonly limit: number;
- readonly remaining: number;
- readonly reset: number;
- readonly used: number;
+ /**
+ * Organization ruleset conditions
+ * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.
+ *
+ */
+ readonly "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]);
+ /**
+ * creation
+ * @description Only allow users with bypass permission to create matching refs.
+ */
+ readonly "repository-rule-creation": {
+ /** @enum {string} */
+ readonly type: "creation";
};
/**
- * Rate Limit Overview
- * @description Rate Limit Overview
+ * update
+ * @description Only allow users with bypass permission to update matching refs.
*/
- readonly "rate-limit-overview": {
- readonly resources: {
- readonly core: components["schemas"]["rate-limit"];
- readonly graphql?: components["schemas"]["rate-limit"];
- readonly search: components["schemas"]["rate-limit"];
- readonly code_search?: components["schemas"]["rate-limit"];
- readonly source_import?: components["schemas"]["rate-limit"];
- readonly integration_manifest?: components["schemas"]["rate-limit"];
- readonly code_scanning_upload?: components["schemas"]["rate-limit"];
- readonly actions_runner_registration?: components["schemas"]["rate-limit"];
- readonly scim?: components["schemas"]["rate-limit"];
- readonly dependency_snapshots?: components["schemas"]["rate-limit"];
+ readonly "repository-rule-update": {
+ /** @enum {string} */
+ readonly type: "update";
+ readonly parameters?: {
+ /** @description Branch can pull changes from its upstream repository */
+ readonly update_allows_fetch_and_merge: boolean;
};
- readonly rate: components["schemas"]["rate-limit"];
};
/**
- * Repository
- * @description A repository on GitHub.
+ * deletion
+ * @description Only allow users with bypass permissions to delete matching refs.
*/
- readonly "nullable-repository": {
+ readonly "repository-rule-deletion": {
+ /** @enum {string} */
+ readonly type: "deletion";
+ };
+ /**
+ * required_linear_history
+ * @description Prevent merge commits from being pushed to matching refs.
+ */
+ readonly "repository-rule-required-linear-history": {
+ /** @enum {string} */
+ readonly type: "required_linear_history";
+ };
+ /**
+ * required_deployments
+ * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
+ */
+ readonly "repository-rule-required-deployments": {
+ /** @enum {string} */
+ readonly type: "required_deployments";
+ readonly parameters?: {
+ /** @description The environments that must be successfully deployed to before branches can be merged. */
+ readonly required_deployment_environments: string[];
+ };
+ };
+ /**
+ * required_signatures
+ * @description Commits pushed to matching refs must have verified signatures.
+ */
+ readonly "repository-rule-required-signatures": {
+ /** @enum {string} */
+ readonly type: "required_signatures";
+ };
+ /**
+ * pull_request
+ * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
+ */
+ readonly "repository-rule-pull-request": {
+ /** @enum {string} */
+ readonly type: "pull_request";
+ readonly parameters?: {
+ /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */
+ readonly dismiss_stale_reviews_on_push: boolean;
+ /** @description Require an approving review in pull requests that modify files that have a designated code owner. */
+ readonly require_code_owner_review: boolean;
+ /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */
+ readonly require_last_push_approval: boolean;
+ /** @description The number of approving reviews that are required before a pull request can be merged. */
+ readonly required_approving_review_count: number;
+ /** @description All conversations on code must be resolved before a pull request can be merged. */
+ readonly required_review_thread_resolution: boolean;
+ };
+ };
+ /**
+ * StatusCheckConfiguration
+ * @description Required status check
+ */
+ readonly "repository-rule-params-status-check-configuration": {
+ /** @description The status check context name that must be present on the commit. */
+ readonly context: string;
+ /** @description The optional integration ID that this status check must originate from. */
+ readonly integration_id?: number;
+ };
+ /**
+ * required_status_checks
+ * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
+ */
+ readonly "repository-rule-required-status-checks": {
+ /** @enum {string} */
+ readonly type: "required_status_checks";
+ readonly parameters?: {
+ /** @description Status checks that are required. */
+ readonly required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][];
+ /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */
+ readonly strict_required_status_checks_policy: boolean;
+ };
+ };
+ /**
+ * non_fast_forward
+ * @description Prevent users with push access from force pushing to refs.
+ */
+ readonly "repository-rule-non-fast-forward": {
+ /** @enum {string} */
+ readonly type: "non_fast_forward";
+ };
+ /**
+ * commit_message_pattern
+ * @description Parameters to be used for the commit_message_pattern rule
+ */
+ readonly "repository-rule-commit-message-pattern": {
+ /** @enum {string} */
+ readonly type: "commit_message_pattern";
+ readonly parameters?: {
+ /** @description How this rule will appear to users. */
+ readonly name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ readonly negate?: boolean;
+ /**
+ * @description The operator to use for matching.
+ * @enum {string}
+ */
+ readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ readonly pattern: string;
+ };
+ };
+ /**
+ * commit_author_email_pattern
+ * @description Parameters to be used for the commit_author_email_pattern rule
+ */
+ readonly "repository-rule-commit-author-email-pattern": {
+ /** @enum {string} */
+ readonly type: "commit_author_email_pattern";
+ readonly parameters?: {
+ /** @description How this rule will appear to users. */
+ readonly name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ readonly negate?: boolean;
+ /**
+ * @description The operator to use for matching.
+ * @enum {string}
+ */
+ readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ readonly pattern: string;
+ };
+ };
+ /**
+ * committer_email_pattern
+ * @description Parameters to be used for the committer_email_pattern rule
+ */
+ readonly "repository-rule-committer-email-pattern": {
+ /** @enum {string} */
+ readonly type: "committer_email_pattern";
+ readonly parameters?: {
+ /** @description How this rule will appear to users. */
+ readonly name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ readonly negate?: boolean;
+ /**
+ * @description The operator to use for matching.
+ * @enum {string}
+ */
+ readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ readonly pattern: string;
+ };
+ };
+ /**
+ * branch_name_pattern
+ * @description Parameters to be used for the branch_name_pattern rule
+ */
+ readonly "repository-rule-branch-name-pattern": {
+ /** @enum {string} */
+ readonly type: "branch_name_pattern";
+ readonly parameters?: {
+ /** @description How this rule will appear to users. */
+ readonly name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ readonly negate?: boolean;
+ /**
+ * @description The operator to use for matching.
+ * @enum {string}
+ */
+ readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ readonly pattern: string;
+ };
+ };
+ /**
+ * tag_name_pattern
+ * @description Parameters to be used for the tag_name_pattern rule
+ */
+ readonly "repository-rule-tag-name-pattern": {
+ /** @enum {string} */
+ readonly type: "tag_name_pattern";
+ readonly parameters?: {
+ /** @description How this rule will appear to users. */
+ readonly name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ readonly negate?: boolean;
+ /**
+ * @description The operator to use for matching.
+ * @enum {string}
+ */
+ readonly operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ readonly pattern: string;
+ };
+ };
+ /**
+ * RestrictedCommits
+ * @description Restricted commit
+ */
+ readonly "repository-rule-params-restricted-commits": {
+ /** @description Full or abbreviated commit hash to reject */
+ readonly oid: string;
+ /** @description Reason for restriction */
+ readonly reason?: string;
+ };
+ /**
+ * WorkflowFileReference
+ * @description A workflow that must run for this rule to pass
+ */
+ readonly "repository-rule-params-workflow-file-reference": {
+ /** @description The path to the workflow file */
+ readonly path: string;
+ /** @description The ref (branch or tag) of the workflow file to use */
+ readonly ref?: string;
+ /** @description The ID of the repository where the workflow is defined */
+ readonly repository_id: number;
+ /** @description The commit SHA of the workflow file to use */
+ readonly sha?: string;
+ };
+ /**
+ * workflows
+ * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
+ */
+ readonly "repository-rule-workflows": {
+ /** @enum {string} */
+ readonly type: "workflows";
+ readonly parameters?: {
+ /** @description Workflows that must pass for this rule to pass. */
+ readonly workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][];
+ };
+ };
+ /**
+ * CodeScanningTool
+ * @description A tool that must provide code scanning results for this rule to pass.
+ */
+ readonly "repository-rule-params-code-scanning-tool": {
/**
- * @description Unique identifier of the repository
- * @example 42
+ * @description The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
+ * @enum {string}
*/
- readonly id: number;
- /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
- readonly node_id: string;
+ readonly alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all";
/**
- * @description The name of the repository.
- * @example Team Environment
+ * @description The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
+ * @enum {string}
*/
- readonly name: string;
- /** @example octocat/Hello-World */
- readonly full_name: string;
- readonly license: components["schemas"]["nullable-license-simple"];
- readonly organization?: components["schemas"]["nullable-simple-user"];
- readonly forks: number;
- readonly permissions?: {
- readonly admin: boolean;
- readonly pull: boolean;
- readonly triage?: boolean;
- readonly push: boolean;
- readonly maintain?: boolean;
+ readonly security_alerts_threshold: "none" | "critical" | "high_or_higher" | "medium_or_higher" | "all";
+ /** @description The name of a code scanning tool */
+ readonly tool: string;
+ };
+ /**
+ * Repository Rule
+ * @description A repository rule.
+ */
+ readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | {
+ /** @enum {string} */
+ readonly type: "file_path_restriction";
+ readonly parameters?: {
+ /** @description The file paths that are restricted from being pushed to the commit graph. */
+ readonly restricted_file_paths: string[];
};
- readonly owner: components["schemas"]["simple-user"];
+ } | {
+ /** @enum {string} */
+ readonly type: "max_file_path_length";
+ readonly parameters?: {
+ /** @description The maximum amount of characters allowed in file paths */
+ readonly max_file_path_length: number;
+ };
+ } | {
+ /** @enum {string} */
+ readonly type: "file_extension_restriction";
+ readonly parameters?: {
+ /** @description The file extensions that are restricted from being pushed to the commit graph. */
+ readonly restricted_file_extensions: string[];
+ };
+ } | {
+ /** @enum {string} */
+ readonly type: "max_file_size";
+ readonly parameters?: {
+ /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */
+ readonly max_file_size: number;
+ };
+ } | components["schemas"]["repository-rule-workflows"];
+ /**
+ * Repository ruleset
+ * @description A set of rules to apply when specified conditions are met.
+ */
+ readonly "repository-ruleset": {
+ /** @description The ID of the ruleset */
+ readonly id: number;
+ /** @description The name of the ruleset */
+ readonly name: string;
/**
- * @description Whether the repository is private or public.
- * @default false
+ * @description The target of the ruleset
+ *
+ * **Note**: The `push` target is in beta and is subject to change.
+ * @enum {string}
*/
- readonly private: boolean;
+ readonly target?: "branch" | "tag" | "push";
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World
+ * @description The type of the source of the ruleset
+ * @enum {string}
*/
- readonly html_url: string;
- /** @example This your first repo! */
- readonly description: string | null;
- readonly fork: boolean;
+ readonly source_type?: "Repository" | "Organization";
+ /** @description The name of the source */
+ readonly source: string;
+ readonly enforcement: components["schemas"]["repository-rule-enforcement"];
+ /** @description The actors that can bypass the rules in this ruleset */
+ readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][];
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World
+ * @description The bypass type of the user making the API request for this ruleset. This field is only returned when
+ * querying the repository-level endpoint.
+ * @enum {string}
*/
- readonly url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
- readonly archive_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
- readonly assignees_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
- readonly blobs_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
- readonly branches_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
- readonly collaborators_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
- readonly comments_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
- readonly commits_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
- readonly compare_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
- readonly contents_url: string;
+ readonly current_user_can_bypass?: "always" | "pull_requests_only" | "never";
+ readonly node_id?: string;
+ readonly _links?: {
+ readonly self?: {
+ /** @description The URL of the ruleset */
+ readonly href?: string;
+ };
+ readonly html?: {
+ /** @description The html URL of the ruleset */
+ readonly href?: string;
+ };
+ };
+ readonly conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null;
+ readonly rules?: components["schemas"]["repository-rule"][];
+ /** Format: date-time */
+ readonly created_at?: string;
+ /** Format: date-time */
+ readonly updated_at?: string;
+ };
+ /**
+ * Rule Suites
+ * @description Response
+ */
+ readonly "rule-suites": {
+ /** @description The unique identifier of the rule insight. */
+ readonly id?: number;
+ /** @description The number that identifies the user. */
+ readonly actor_id?: number;
+ /** @description The handle for the GitHub user account. */
+ readonly actor_name?: string;
+ /** @description The first commit sha before the push evaluation. */
+ readonly before_sha?: string;
+ /** @description The last commit sha in the push evaluation. */
+ readonly after_sha?: string;
+ /** @description The ref name that the evaluation ran on. */
+ readonly ref?: string;
+ /** @description The ID of the repository associated with the rule evaluation. */
+ readonly repository_id?: number;
+ /** @description The name of the repository without the `.git` extension. */
+ readonly repository_name?: string;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/contributors
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
*/
- readonly contributors_url: string;
+ readonly pushed_at?: string;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/deployments
+ * @description The result of the rule evaluations for rules with the `active` enforcement status.
+ * @enum {string}
*/
- readonly deployments_url: string;
+ readonly result?: "pass" | "fail" | "bypass";
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/downloads
+ * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`.
+ * @enum {string}
*/
- readonly downloads_url: string;
+ readonly evaluation_result?: "pass" | "fail";
+ }[];
+ /**
+ * Rule Suite
+ * @description Response
+ */
+ readonly "rule-suite": {
+ /** @description The unique identifier of the rule insight. */
+ readonly id?: number;
+ /** @description The number that identifies the user. */
+ readonly actor_id?: number | null;
+ /** @description The handle for the GitHub user account. */
+ readonly actor_name?: string | null;
+ /** @description The first commit sha before the push evaluation. */
+ readonly before_sha?: string;
+ /** @description The last commit sha in the push evaluation. */
+ readonly after_sha?: string;
+ /** @description The ref name that the evaluation ran on. */
+ readonly ref?: string;
+ /** @description The ID of the repository associated with the rule evaluation. */
+ readonly repository_id?: number;
+ /** @description The name of the repository without the `.git` extension. */
+ readonly repository_name?: string;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/events
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
*/
- readonly events_url: string;
+ readonly pushed_at?: string;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/forks
+ * @description The result of the rule evaluations for rules with the `active` enforcement status.
+ * @enum {string}
*/
- readonly forks_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
- readonly git_commits_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
- readonly git_refs_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
- readonly git_tags_url: string;
- /** @example git:github.com/octocat/Hello-World.git */
- readonly git_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
- readonly issue_comment_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
- readonly issue_events_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
- readonly issues_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
- readonly keys_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
- readonly labels_url: string;
+ readonly result?: "pass" | "fail" | "bypass";
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/languages
+ * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`.
+ * @enum {string}
*/
- readonly languages_url: string;
+ readonly evaluation_result?: "pass" | "fail";
+ /** @description Details on the evaluated rules. */
+ readonly rule_evaluations?: {
+ readonly rule_source?: {
+ /** @description The type of rule source. */
+ readonly type?: string;
+ /** @description The ID of the rule source. */
+ readonly id?: number | null;
+ /** @description The name of the rule source. */
+ readonly name?: string | null;
+ };
+ /**
+ * @description The enforcement level of this rule source.
+ * @enum {string}
+ */
+ readonly enforcement?: "active" | "evaluate" | "deleted ruleset";
+ /**
+ * @description The result of the evaluation of the individual rule.
+ * @enum {string}
+ */
+ readonly result?: "pass" | "fail";
+ /** @description The type of rule. */
+ readonly rule_type?: string;
+ /** @description Any associated details with the rule evaluation. */
+ readonly details?: string;
+ }[];
+ };
+ /** @description A product affected by the vulnerability detailed in a repository security advisory. */
+ readonly "repository-advisory-vulnerability": {
+ /** @description The name of the package affected by the vulnerability. */
+ readonly package: {
+ readonly ecosystem: components["schemas"]["security-advisory-ecosystems"];
+ /** @description The unique package name within its ecosystem. */
+ readonly name: string | null;
+ } | null;
+ /** @description The range of the package versions affected by the vulnerability. */
+ readonly vulnerable_version_range: string | null;
+ /** @description The package version(s) that resolve the vulnerability. */
+ readonly patched_versions: string | null;
+ /** @description The functions in the package that are affected. */
+ readonly vulnerable_functions: string[] | null;
+ };
+ /** @description A credit given to a user for a repository security advisory. */
+ readonly "repository-advisory-credit": {
+ readonly user: components["schemas"]["simple-user"];
+ readonly type: components["schemas"]["security-advisory-credit-types"];
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/merges
+ * @description The state of the user's acceptance of the credit.
+ * @enum {string}
*/
- readonly merges_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
- readonly milestones_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
- readonly notifications_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
- readonly pulls_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
- readonly releases_url: string;
- /** @example git@github.com:octocat/Hello-World.git */
- readonly ssh_url: string;
+ readonly state: "accepted" | "declined" | "pending";
+ };
+ /** @description A repository security advisory. */
+ readonly "repository-advisory": {
+ /** @description The GitHub Security Advisory ID. */
+ readonly ghsa_id: string;
+ /** @description The Common Vulnerabilities and Exposures (CVE) ID. */
+ readonly cve_id: string | null;
/**
* Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/stargazers
+ * @description The API URL for the advisory.
*/
- readonly stargazers_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
- readonly statuses_url: string;
+ readonly url: string;
/**
* Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/subscribers
+ * @description The URL for the advisory.
*/
- readonly subscribers_url: string;
+ readonly html_url: string;
+ /** @description A short summary of the advisory. */
+ readonly summary: string;
+ /** @description A detailed description of what the advisory entails. */
+ readonly description: string | null;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/subscription
+ * @description The severity of the advisory.
+ * @enum {string|null}
*/
- readonly subscription_url: string;
+ readonly severity: "critical" | "high" | "medium" | "low";
+ /** @description The author of the advisory. */
+ readonly author: components["schemas"]["simple-user"] | null;
+ /** @description The publisher of the advisory. */
+ readonly publisher: components["schemas"]["simple-user"] | null;
+ readonly identifiers: {
+ /**
+ * @description The type of identifier.
+ * @enum {string}
+ */
+ readonly type: "CVE" | "GHSA";
+ /** @description The identifier value. */
+ readonly value: string;
+ }[];
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/tags
+ * @description The state of the advisory.
+ * @enum {string}
*/
- readonly tags_url: string;
+ readonly state: "published" | "closed" | "withdrawn" | "draft" | "triage";
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/teams
+ * Format: date-time
+ * @description The date and time of when the advisory was created, in ISO 8601 format.
*/
- readonly teams_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
- readonly trees_url: string;
- /** @example https://github.com/octocat/Hello-World.git */
- readonly clone_url: string;
+ readonly created_at: string | null;
/**
- * Format: uri
- * @example git:git.example.com/octocat/Hello-World
+ * Format: date-time
+ * @description The date and time of when the advisory was last updated, in ISO 8601 format.
*/
- readonly mirror_url: string | null;
+ readonly updated_at: string | null;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/hooks
+ * Format: date-time
+ * @description The date and time of when the advisory was published, in ISO 8601 format.
*/
- readonly hooks_url: string;
+ readonly published_at: string | null;
/**
- * Format: uri
- * @example https://svn.github.com/octocat/Hello-World
+ * Format: date-time
+ * @description The date and time of when the advisory was closed, in ISO 8601 format.
*/
- readonly svn_url: string;
+ readonly closed_at: string | null;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was withdrawn, in ISO 8601 format.
+ */
+ readonly withdrawn_at: string | null;
+ readonly submission: {
+ /** @description Whether a private vulnerability report was accepted by the repository's administrators. */
+ readonly accepted: boolean;
+ } | null;
+ readonly vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null;
+ readonly cvss: {
+ /** @description The CVSS vector. */
+ readonly vector_string: string | null;
+ /** @description The CVSS score. */
+ readonly score: number | null;
+ } | null;
+ readonly cwes: {
+ /** @description The Common Weakness Enumeration (CWE) identifier. */
+ readonly cwe_id: string;
+ /** @description The name of the CWE. */
+ readonly name: string;
+ }[] | null;
+ /** @description A list of only the CWE IDs. */
+ readonly cwe_ids: string[] | null;
+ readonly credits: {
+ /** @description The username of the user credited. */
+ readonly login?: string;
+ readonly type?: components["schemas"]["security-advisory-credit-types"];
+ }[] | null;
+ readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null;
+ /** @description A list of users that collaborate on the advisory. */
+ readonly collaborating_users: components["schemas"]["simple-user"][] | null;
+ /** @description A list of teams that collaborate on the advisory. */
+ readonly collaborating_teams: components["schemas"]["team"][] | null;
+ /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */
+ readonly private_fork: components["schemas"]["simple-repository"] | null;
+ };
+ /**
+ * Team Simple
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ readonly "team-simple": {
+ /**
+ * @description Unique identifier of the team
+ * @example 1
+ */
+ readonly id: number;
+ /** @example MDQ6VGVhbTE= */
+ readonly node_id: string;
/**
* Format: uri
- * @example https://github.com
+ * @description URL for the team
+ * @example https://api.github.com/organizations/1/team/1
*/
- readonly homepage: string | null;
- readonly language: string | null;
- /** @example 9 */
- readonly forks_count: number;
- /** @example 80 */
- readonly stargazers_count: number;
- /** @example 80 */
- readonly watchers_count: number;
+ readonly url: string;
+ /** @example https://api.github.com/organizations/1/team/1/members{/member} */
+ readonly members_url: string;
/**
- * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- * @example 108
+ * @description Name of the team
+ * @example Justice League
*/
- readonly size: number;
+ readonly name: string;
/**
- * @description The default branch of the repository.
- * @example master
+ * @description Description of the team
+ * @example A great team.
*/
- readonly default_branch: string;
- /** @example 0 */
- readonly open_issues_count: number;
+ readonly description: string | null;
/**
- * @description Whether this repository acts as a template that can be used to generate new repositories.
- * @default false
- * @example true
+ * @description Permission that the team will have for its repositories
+ * @example admin
*/
- readonly is_template: boolean;
- readonly topics?: string[];
+ readonly permission: string;
/**
- * @description Whether issues are enabled.
- * @default true
- * @example true
+ * @description The level of privacy this team should have
+ * @example closed
*/
- readonly has_issues: boolean;
+ readonly privacy?: string;
/**
- * @description Whether projects are enabled.
- * @default true
- * @example true
+ * @description The notification setting the team has set
+ * @example notifications_enabled
*/
- readonly has_projects: boolean;
+ readonly notification_setting?: string;
/**
- * @description Whether the wiki is enabled.
- * @default true
- * @example true
+ * Format: uri
+ * @example https://github.com/orgs/rails/teams/core
*/
- readonly has_wiki: boolean;
- readonly has_pages: boolean;
+ readonly html_url: string;
/**
- * @deprecated
- * @description Whether downloads are enabled.
- * @default true
- * @example true
+ * Format: uri
+ * @example https://api.github.com/organizations/1/team/1/repos
*/
- readonly has_downloads: boolean;
+ readonly repositories_url: string;
+ /** @example justice-league */
+ readonly slug: string;
/**
- * @description Whether discussions are enabled.
- * @default false
- * @example true
+ * @description Distinguished Name (DN) that team maps to within LDAP environment
+ * @example uid=example,ou=users,dc=github,dc=com
*/
- readonly has_discussions: boolean;
+ readonly ldap_dn?: string;
+ };
+ readonly "actions-billing-usage": {
+ /** @description The sum of the free and paid GitHub Actions minutes used. */
+ readonly total_minutes_used: number;
+ /** @description The total paid GitHub Actions minutes used. */
+ readonly total_paid_minutes_used: number;
+ /** @description The amount of free GitHub Actions minutes available. */
+ readonly included_minutes: number;
+ readonly minutes_used_breakdown: {
+ /** @description Total minutes used on Ubuntu runner machines. */
+ readonly UBUNTU?: number;
+ /** @description Total minutes used on macOS runner machines. */
+ readonly MACOS?: number;
+ /** @description Total minutes used on Windows runner machines. */
+ readonly WINDOWS?: number;
+ /** @description Total minutes used on Ubuntu 4 core runner machines. */
+ readonly ubuntu_4_core?: number;
+ /** @description Total minutes used on Ubuntu 8 core runner machines. */
+ readonly ubuntu_8_core?: number;
+ /** @description Total minutes used on Ubuntu 16 core runner machines. */
+ readonly ubuntu_16_core?: number;
+ /** @description Total minutes used on Ubuntu 32 core runner machines. */
+ readonly ubuntu_32_core?: number;
+ /** @description Total minutes used on Ubuntu 64 core runner machines. */
+ readonly ubuntu_64_core?: number;
+ /** @description Total minutes used on Windows 4 core runner machines. */
+ readonly windows_4_core?: number;
+ /** @description Total minutes used on Windows 8 core runner machines. */
+ readonly windows_8_core?: number;
+ /** @description Total minutes used on Windows 16 core runner machines. */
+ readonly windows_16_core?: number;
+ /** @description Total minutes used on Windows 32 core runner machines. */
+ readonly windows_32_core?: number;
+ /** @description Total minutes used on Windows 64 core runner machines. */
+ readonly windows_64_core?: number;
+ /** @description Total minutes used on macOS 12 core runner machines. */
+ readonly macos_12_core?: number;
+ /** @description Total minutes used on all runner machines. */
+ readonly total?: number;
+ };
+ };
+ readonly "packages-billing-usage": {
+ /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */
+ readonly total_gigabytes_bandwidth_used: number;
+ /** @description Total paid storage space (GB) for GitHuub Packages. */
+ readonly total_paid_gigabytes_bandwidth_used: number;
+ /** @description Free storage space (GB) for GitHub Packages. */
+ readonly included_gigabytes_bandwidth: number;
+ };
+ readonly "combined-billing-usage": {
+ /** @description Numbers of days left in billing cycle. */
+ readonly days_left_in_billing_cycle: number;
+ /** @description Estimated storage space (GB) used in billing cycle. */
+ readonly estimated_paid_storage_for_month: number;
+ /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */
+ readonly estimated_storage_for_month: number;
+ };
+ /**
+ * Team Organization
+ * @description Team Organization
+ */
+ readonly "team-organization": {
+ /** @example github */
+ readonly login: string;
+ /** @example 1 */
+ readonly id: number;
+ /** @example MDEyOk9yZ2FuaXphdGlvbjE= */
+ readonly node_id: string;
/**
- * @description Whether the repository is archived.
- * @default false
+ * Format: uri
+ * @example https://api.github.com/orgs/github
*/
- readonly archived: boolean;
- /** @description Returns whether or not this repository disabled. */
- readonly disabled: boolean;
+ readonly url: string;
/**
- * @description The repository visibility: public, private, or internal.
- * @default public
+ * Format: uri
+ * @example https://api.github.com/orgs/github/repos
*/
- readonly visibility: string;
+ readonly repos_url: string;
/**
- * Format: date-time
- * @example 2011-01-26T19:06:43Z
+ * Format: uri
+ * @example https://api.github.com/orgs/github/events
*/
- readonly pushed_at: string | null;
+ readonly events_url: string;
+ /** @example https://api.github.com/orgs/github/hooks */
+ readonly hooks_url: string;
+ /** @example https://api.github.com/orgs/github/issues */
+ readonly issues_url: string;
+ /** @example https://api.github.com/orgs/github/members{/member} */
+ readonly members_url: string;
+ /** @example https://api.github.com/orgs/github/public_members{/member} */
+ readonly public_members_url: string;
+ /** @example https://github.com/images/error/octocat_happy.gif */
+ readonly avatar_url: string;
+ /** @example A great organization */
+ readonly description: string | null;
+ /** @example github */
+ readonly name?: string;
+ /** @example GitHub */
+ readonly company?: string;
/**
- * Format: date-time
- * @example 2011-01-26T19:01:12Z
+ * Format: uri
+ * @example https://github.com/blog
*/
- readonly created_at: string | null;
+ readonly blog?: string;
+ /** @example San Francisco */
+ readonly location?: string;
+ /**
+ * Format: email
+ * @example octocat@github.com
+ */
+ readonly email?: string;
+ /** @example github */
+ readonly twitter_username?: string | null;
+ /** @example true */
+ readonly is_verified?: boolean;
+ /** @example true */
+ readonly has_organization_projects: boolean;
+ /** @example true */
+ readonly has_repository_projects: boolean;
+ /** @example 2 */
+ readonly public_repos: number;
+ /** @example 1 */
+ readonly public_gists: number;
+ /** @example 20 */
+ readonly followers: number;
+ /** @example 0 */
+ readonly following: number;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat
+ */
+ readonly html_url: string;
/**
* Format: date-time
- * @example 2011-01-26T19:14:43Z
+ * @example 2008-01-14T04:33:35Z
*/
- readonly updated_at: string | null;
+ readonly created_at: string;
+ /** @example Organization */
+ readonly type: string;
+ /** @example 100 */
+ readonly total_private_repos?: number;
+ /** @example 100 */
+ readonly owned_private_repos?: number;
+ /** @example 81 */
+ readonly private_gists?: number | null;
+ /** @example 10000 */
+ readonly disk_usage?: number | null;
+ /** @example 8 */
+ readonly collaborators?: number | null;
/**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- * @example true
+ * Format: email
+ * @example org@example.com
*/
- readonly allow_rebase_merge: boolean;
- readonly template_repository?: {
- readonly id?: number;
- readonly node_id?: string;
- readonly name?: string;
- readonly full_name?: string;
- readonly owner?: {
- readonly login?: string;
- readonly id?: number;
- readonly node_id?: string;
- readonly avatar_url?: string;
- readonly gravatar_id?: string;
- readonly url?: string;
- readonly html_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly organizations_url?: string;
- readonly repos_url?: string;
- readonly events_url?: string;
- readonly received_events_url?: string;
- readonly type?: string;
- readonly site_admin?: boolean;
- };
- readonly private?: boolean;
- readonly html_url?: string;
- readonly description?: string;
- readonly fork?: boolean;
- readonly url?: string;
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly forks_url?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly git_url?: string;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly notifications_url?: string;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly ssh_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly clone_url?: string;
- readonly mirror_url?: string;
- readonly hooks_url?: string;
- readonly svn_url?: string;
- readonly homepage?: string;
- readonly language?: string;
- readonly forks_count?: number;
- readonly stargazers_count?: number;
- readonly watchers_count?: number;
- readonly size?: number;
- readonly default_branch?: string;
- readonly open_issues_count?: number;
- readonly is_template?: boolean;
- readonly topics?: string[];
- readonly has_issues?: boolean;
- readonly has_projects?: boolean;
- readonly has_wiki?: boolean;
- readonly has_pages?: boolean;
- readonly has_downloads?: boolean;
- readonly archived?: boolean;
- readonly disabled?: boolean;
- readonly visibility?: string;
- readonly pushed_at?: string;
- readonly created_at?: string;
- readonly updated_at?: string;
- readonly permissions?: {
- readonly admin?: boolean;
- readonly maintain?: boolean;
- readonly push?: boolean;
- readonly triage?: boolean;
- readonly pull?: boolean;
- };
- readonly allow_rebase_merge?: boolean;
- readonly temp_clone_token?: string;
- readonly allow_squash_merge?: boolean;
- readonly allow_auto_merge?: boolean;
- readonly delete_branch_on_merge?: boolean;
- readonly allow_update_branch?: boolean;
- readonly use_squash_pr_title_as_default?: boolean;
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- readonly allow_merge_commit?: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
- } | null;
- readonly temp_clone_token?: string;
+ readonly billing_email?: string | null;
+ readonly plan?: {
+ readonly name: string;
+ readonly space: number;
+ readonly private_repos: number;
+ readonly filled_seats?: number;
+ readonly seats?: number;
+ };
+ readonly default_repository_permission?: string | null;
+ /** @example true */
+ readonly members_can_create_repositories?: boolean | null;
+ /** @example true */
+ readonly two_factor_requirement_enabled?: boolean | null;
+ /** @example all */
+ readonly members_allowed_repository_creation_type?: string;
+ /** @example true */
+ readonly members_can_create_public_repositories?: boolean;
+ /** @example true */
+ readonly members_can_create_private_repositories?: boolean;
+ /** @example true */
+ readonly members_can_create_internal_repositories?: boolean;
+ /** @example true */
+ readonly members_can_create_pages?: boolean;
+ /** @example true */
+ readonly members_can_create_public_pages?: boolean;
+ /** @example true */
+ readonly members_can_create_private_pages?: boolean;
+ /** @example false */
+ readonly members_can_fork_private_repositories?: boolean | null;
+ /** @example false */
+ readonly web_commit_signoff_required?: boolean;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: date-time */
+ readonly archived_at: string | null;
+ };
+ /**
+ * Full Team
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ readonly "team-full": {
/**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- * @example true
+ * @description Unique identifier of the team
+ * @example 42
*/
- readonly allow_squash_merge: boolean;
+ readonly id: number;
+ /** @example MDQ6VGVhbTE= */
+ readonly node_id: string;
/**
- * @description Whether to allow Auto-merge to be used on pull requests.
- * @default false
- * @example false
+ * Format: uri
+ * @description URL for the team
+ * @example https://api.github.com/organizations/1/team/1
*/
- readonly allow_auto_merge: boolean;
+ readonly url: string;
/**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- * @example false
+ * Format: uri
+ * @example https://github.com/orgs/rails/teams/core
*/
- readonly delete_branch_on_merge: boolean;
+ readonly html_url: string;
/**
- * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- * @default false
- * @example false
+ * @description Name of the team
+ * @example Developers
*/
- readonly allow_update_branch: boolean;
+ readonly name: string;
+ /** @example justice-league */
+ readonly slug: string;
+ /** @example A great team. */
+ readonly description: string | null;
/**
- * @deprecated
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
+ * @description The level of privacy this team should have
+ * @example closed
+ * @enum {string}
*/
- readonly use_squash_pr_title_as_default: boolean;
+ readonly privacy?: "closed" | "secret";
/**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @description The notification setting the team has set
+ * @example notifications_enabled
* @enum {string}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
/**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
+ * @description Permission that the team will have for its repositories
+ * @example push
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ readonly permission: string;
+ /** @example https://api.github.com/organizations/1/team/1/members{/member} */
+ readonly members_url: string;
/**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
+ * Format: uri
+ * @example https://api.github.com/organizations/1/team/1/repos
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ readonly repositories_url: string;
+ readonly parent?: components["schemas"]["nullable-team-simple"];
+ /** @example 3 */
+ readonly members_count: number;
+ /** @example 10 */
+ readonly repos_count: number;
/**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
+ * Format: date-time
+ * @example 2017-07-14T16:53:42Z
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ readonly created_at: string;
/**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- * @example true
+ * Format: date-time
+ * @example 2017-08-17T12:37:15Z
*/
- readonly allow_merge_commit: boolean;
- /** @description Whether to allow forking this repo */
- readonly allow_forking?: boolean;
+ readonly updated_at: string;
+ readonly organization: components["schemas"]["team-organization"];
/**
- * @description Whether to require contributors to sign off on web-based commits
- * @default false
+ * @description Distinguished Name (DN) that team maps to within LDAP environment
+ * @example uid=example,ou=users,dc=github,dc=com
*/
- readonly web_commit_signoff_required: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
- readonly open_issues: number;
- readonly watchers: number;
- readonly master_branch?: string;
- /** @example "2020-07-09T00:17:42Z" */
- readonly starred_at?: string;
- /** @description Whether anonymous git access is enabled for this repository */
- readonly anonymous_access_enabled?: boolean;
- } | null;
+ readonly ldap_dn?: string;
+ };
/**
- * Code Of Conduct Simple
- * @description Code of Conduct Simple
+ * Team Discussion
+ * @description A team discussion is a persistent record of a free-form conversation within a team.
*/
- readonly "code-of-conduct-simple": {
+ readonly "team-discussion": {
+ readonly author: components["schemas"]["nullable-simple-user"];
+ /**
+ * @description The main text of the discussion.
+ * @example Please suggest improvements to our workflow in comments.
+ */
+ readonly body: string;
+ /** @example Hi! This is an area for us to collaborate as a team
*/
+ readonly body_html: string;
+ /**
+ * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
+ * @example 0307116bbf7ced493b8d8a346c650b71
+ */
+ readonly body_version: string;
+ /** @example 0 */
+ readonly comments_count: number;
/**
* Format: uri
- * @example https://api.github.com/repos/github/docs/community/code_of_conduct
+ * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments
+ */
+ readonly comments_url: string;
+ /**
+ * Format: date-time
+ * @example 2018-01-25T18:56:31Z
+ */
+ readonly created_at: string;
+ /** Format: date-time */
+ readonly last_edited_at: string | null;
+ /**
+ * Format: uri
+ * @example https://github.com/orgs/github/teams/justice-league/discussions/1
+ */
+ readonly html_url: string;
+ /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */
+ readonly node_id: string;
+ /**
+ * @description The unique sequence number of a team discussion.
+ * @example 42
+ */
+ readonly number: number;
+ /**
+ * @description Whether or not this discussion should be pinned for easy retrieval.
+ * @example true
+ */
+ readonly pinned: boolean;
+ /**
+ * @description Whether or not this discussion should be restricted to team members and organization owners.
+ * @example true
+ */
+ readonly private: boolean;
+ /**
+ * Format: uri
+ * @example https://api.github.com/organizations/1/team/2343027
+ */
+ readonly team_url: string;
+ /**
+ * @description The title of the discussion.
+ * @example How can we improve our workflow?
+ */
+ readonly title: string;
+ /**
+ * Format: date-time
+ * @example 2018-01-25T18:56:31Z
+ */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/organizations/1/team/2343027/discussions/1
*/
readonly url: string;
- /** @example citizen_code_of_conduct */
- readonly key: string;
- /** @example Citizen Code of Conduct */
- readonly name: string;
+ readonly reactions?: components["schemas"]["reaction-rollup"];
+ };
+ /**
+ * Team Discussion Comment
+ * @description A reply to a discussion within a team.
+ */
+ readonly "team-discussion-comment": {
+ readonly author: components["schemas"]["nullable-simple-user"];
+ /**
+ * @description The main text of the comment.
+ * @example I agree with this suggestion.
+ */
+ readonly body: string;
+ /** @example Do you like apples?
*/
+ readonly body_html: string;
+ /**
+ * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
+ * @example 0307116bbf7ced493b8d8a346c650b71
+ */
+ readonly body_version: string;
+ /**
+ * Format: date-time
+ * @example 2018-01-15T23:53:58Z
+ */
+ readonly created_at: string;
+ /** Format: date-time */
+ readonly last_edited_at: string | null;
/**
* Format: uri
- * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
+ * @example https://api.github.com/organizations/1/team/2403582/discussions/1
*/
- readonly html_url: string | null;
+ readonly discussion_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
+ */
+ readonly html_url: string;
+ /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */
+ readonly node_id: string;
+ /**
+ * @description The unique sequence number of a team discussion comment.
+ * @example 42
+ */
+ readonly number: number;
+ /**
+ * Format: date-time
+ * @example 2018-01-15T23:53:58Z
+ */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
+ */
+ readonly url: string;
+ readonly reactions?: components["schemas"]["reaction-rollup"];
};
/**
- * Full Repository
- * @description Full Repository
+ * Reaction
+ * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively.
*/
- readonly "full-repository": {
- /** @example 1296269 */
+ readonly reaction: {
+ /** @example 1 */
+ readonly id: number;
+ /** @example MDg6UmVhY3Rpb24x */
+ readonly node_id: string;
+ readonly user: components["schemas"]["nullable-simple-user"];
+ /**
+ * @description The reaction to use
+ * @example heart
+ * @enum {string}
+ */
+ readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
+ /**
+ * Format: date-time
+ * @example 2016-05-20T20:09:31Z
+ */
+ readonly created_at: string;
+ };
+ /**
+ * Team Membership
+ * @description Team Membership
+ */
+ readonly "team-membership": {
+ /** Format: uri */
+ readonly url: string;
+ /**
+ * @description The role of the user in the team.
+ * @default member
+ * @example member
+ * @enum {string}
+ */
+ readonly role: "member" | "maintainer";
+ /**
+ * @description The state of the user's membership in the team.
+ * @enum {string}
+ */
+ readonly state: "active" | "pending";
+ };
+ /**
+ * Team Project
+ * @description A team's access to a project.
+ */
+ readonly "team-project": {
+ readonly owner_url: string;
+ readonly url: string;
+ readonly html_url: string;
+ readonly columns_url: string;
+ readonly id: number;
+ readonly node_id: string;
+ readonly name: string;
+ readonly body: string | null;
+ readonly number: number;
+ readonly state: string;
+ readonly creator: components["schemas"]["simple-user"];
+ readonly created_at: string;
+ readonly updated_at: string;
+ /** @description The organization permission for this project. Only present when owner is an organization. */
+ readonly organization_permission?: string;
+ /** @description Whether the project is private or not. Only present when owner is an organization. */
+ readonly private?: boolean;
+ readonly permissions: {
+ readonly read: boolean;
+ readonly write: boolean;
+ readonly admin: boolean;
+ };
+ };
+ /**
+ * Team Repository
+ * @description A team's access to a repository.
+ */
+ readonly "team-repository": {
+ /**
+ * @description Unique identifier of the repository
+ * @example 42
+ */
readonly id: number;
/** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
readonly node_id: string;
- /** @example Hello-World */
+ /**
+ * @description The name of the repository.
+ * @example Team Environment
+ */
readonly name: string;
/** @example octocat/Hello-World */
readonly full_name: string;
- readonly owner: components["schemas"]["simple-user"];
+ readonly license: components["schemas"]["nullable-license-simple"];
+ readonly forks: number;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly pull: boolean;
+ readonly triage?: boolean;
+ readonly push: boolean;
+ readonly maintain?: boolean;
+ };
+ /** @example admin */
+ readonly role_name?: string;
+ readonly owner: components["schemas"]["nullable-simple-user"];
+ /**
+ * @description Whether the repository is private or public.
+ * @default false
+ */
readonly private: boolean;
/**
* Format: uri
@@ -23698,142 +24326,252 @@ export interface components {
readonly stargazers_count: number;
/** @example 80 */
readonly watchers_count: number;
+ /** @example 108 */
+ readonly size: number;
/**
- * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- * @example 108
+ * @description The default branch of the repository.
+ * @example master
*/
- readonly size: number;
- /** @example master */
readonly default_branch: string;
/** @example 0 */
readonly open_issues_count: number;
- /** @example true */
- readonly is_template?: boolean;
- /** @example [
- * "octocat",
- * "atom",
- * "electron",
- * "API"
- * ] */
+ /**
+ * @description Whether this repository acts as a template that can be used to generate new repositories.
+ * @default false
+ * @example true
+ */
+ readonly is_template: boolean;
readonly topics?: string[];
- /** @example true */
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ * @example true
+ */
readonly has_issues: boolean;
- /** @example true */
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ * @example true
+ */
readonly has_projects: boolean;
- /** @example true */
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ * @example true
+ */
readonly has_wiki: boolean;
readonly has_pages: boolean;
- /** @example true */
- readonly has_downloads?: boolean;
- /** @example true */
- readonly has_discussions: boolean;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ * @example true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
readonly archived: boolean;
/** @description Returns whether or not this repository disabled. */
readonly disabled: boolean;
/**
* @description The repository visibility: public, private, or internal.
- * @example public
+ * @default public
*/
- readonly visibility?: string;
+ readonly visibility: string;
/**
* Format: date-time
* @example 2011-01-26T19:06:43Z
*/
- readonly pushed_at: string;
+ readonly pushed_at: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- readonly created_at: string;
+ readonly created_at: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:14:43Z
*/
- readonly updated_at: string;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- readonly pull: boolean;
- };
- /** @example true */
- readonly allow_rebase_merge?: boolean;
- readonly template_repository?: components["schemas"]["nullable-repository"];
- readonly temp_clone_token?: string | null;
- /** @example true */
- readonly allow_squash_merge?: boolean;
- /** @example false */
- readonly allow_auto_merge?: boolean;
- /** @example false */
- readonly delete_branch_on_merge?: boolean;
- /** @example true */
- readonly allow_merge_commit?: boolean;
- /** @example true */
- readonly allow_update_branch?: boolean;
- /** @example false */
- readonly use_squash_pr_title_as_default?: boolean;
+ readonly updated_at: string | null;
/**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @example PR_TITLE
- * @enum {string}
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ * @example true
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly allow_rebase_merge: boolean;
+ readonly temp_clone_token?: string;
/**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @example PR_BODY
- * @enum {string}
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ * @example true
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ readonly allow_squash_merge: boolean;
/**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @example PR_TITLE
- * @enum {string}
+ * @description Whether to allow Auto-merge to be used on pull requests.
+ * @default false
+ * @example false
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ readonly allow_auto_merge: boolean;
/**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @example PR_BODY
- * @enum {string}
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ * @example false
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /** @example true */
- readonly allow_forking?: boolean;
- /** @example false */
- readonly web_commit_signoff_required?: boolean;
- /** @example 42 */
- readonly subscribers_count: number;
- /** @example 0 */
- readonly network_count: number;
- readonly license: components["schemas"]["nullable-license-simple"];
- readonly organization?: components["schemas"]["nullable-simple-user"];
- readonly parent?: components["schemas"]["repository"];
- readonly source?: components["schemas"]["repository"];
- readonly forks: number;
- readonly master_branch?: string;
+ readonly delete_branch_on_merge: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ * @example true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow forking this repo
+ * @default false
+ * @example false
+ */
+ readonly allow_forking: boolean;
+ /**
+ * @description Whether to require contributors to sign off on web-based commits
+ * @default false
+ * @example false
+ */
+ readonly web_commit_signoff_required: boolean;
+ readonly subscribers_count?: number;
+ readonly network_count?: number;
readonly open_issues: number;
readonly watchers: number;
+ readonly master_branch?: string;
+ };
+ /**
+ * Project Card
+ * @description Project cards represent a scope of work.
+ */
+ readonly "project-card": {
/**
- * @description Whether anonymous git access is allowed.
- * @default true
+ * Format: uri
+ * @example https://api.github.com/projects/columns/cards/1478
*/
- readonly anonymous_access_enabled: boolean;
- readonly code_of_conduct?: components["schemas"]["code-of-conduct-simple"];
- readonly security_and_analysis?: components["schemas"]["security-and-analysis"];
+ readonly url: string;
+ /**
+ * @description The project card's ID
+ * @example 42
+ */
+ readonly id: number;
+ /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */
+ readonly node_id: string;
+ /** @example Add payload for delete Project column */
+ readonly note: string | null;
+ readonly creator: components["schemas"]["nullable-simple-user"];
+ /**
+ * Format: date-time
+ * @example 2016-09-05T14:21:06Z
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @example 2016-09-05T14:20:22Z
+ */
+ readonly updated_at: string;
+ /**
+ * @description Whether or not the card is archived
+ * @example false
+ */
+ readonly archived?: boolean;
+ readonly column_name?: string;
+ readonly project_id?: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/projects/columns/367
+ */
+ readonly column_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/api-playground/projects-test/issues/3
+ */
+ readonly content_url?: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/projects/120
+ */
+ readonly project_url: string;
+ };
+ /**
+ * Project Column
+ * @description Project columns contain cards of work.
+ */
+ readonly "project-column": {
+ /**
+ * Format: uri
+ * @example https://api.github.com/projects/columns/367
+ */
+ readonly url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/projects/120
+ */
+ readonly project_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/projects/columns/367/cards
+ */
+ readonly cards_url: string;
+ /**
+ * @description The unique identifier of the project column
+ * @example 42
+ */
+ readonly id: number;
+ /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */
+ readonly node_id: string;
+ /**
+ * @description Name of the project column
+ * @example Remaining tasks
+ */
+ readonly name: string;
+ /**
+ * Format: date-time
+ * @example 2016-09-05T14:18:44Z
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @example 2016-09-05T14:22:28Z
+ */
+ readonly updated_at: string;
+ };
+ /**
+ * Project Collaborator Permission
+ * @description Project Collaborator Permission
+ */
+ readonly "project-collaborator-permission": {
+ readonly permission: string;
+ readonly user: components["schemas"]["nullable-simple-user"];
+ };
+ /** Rate Limit */
+ readonly "rate-limit": {
+ readonly limit: number;
+ readonly remaining: number;
+ readonly reset: number;
+ readonly used: number;
+ };
+ /**
+ * Rate Limit Overview
+ * @description Rate Limit Overview
+ */
+ readonly "rate-limit-overview": {
+ readonly resources: {
+ readonly core: components["schemas"]["rate-limit"];
+ readonly graphql?: components["schemas"]["rate-limit"];
+ readonly search: components["schemas"]["rate-limit"];
+ readonly code_search?: components["schemas"]["rate-limit"];
+ readonly source_import?: components["schemas"]["rate-limit"];
+ readonly integration_manifest?: components["schemas"]["rate-limit"];
+ readonly code_scanning_upload?: components["schemas"]["rate-limit"];
+ readonly actions_runner_registration?: components["schemas"]["rate-limit"];
+ readonly scim?: components["schemas"]["rate-limit"];
+ readonly dependency_snapshots?: components["schemas"]["rate-limit"];
+ };
+ readonly rate: components["schemas"]["rate-limit"];
};
/**
* Artifact
@@ -23951,7 +24689,7 @@ export interface components {
* @example queued
* @enum {string}
*/
- readonly status: "queued" | "in_progress" | "completed" | "waiting";
+ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
/**
* @description The outcome of the job.
* @example success
@@ -24118,7 +24856,7 @@ export interface components {
* @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the
* repository.
*
- * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization.
+ * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.
* @enum {string}
*/
readonly access_level: "none" | "user" | "organization";
@@ -25284,11 +26022,11 @@ export interface components {
/** @example https://example.com */
readonly details_url: string | null;
/**
- * @description The phase of the lifecycle that the check is currently in.
+ * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.
* @example queued
* @enum {string}
*/
- readonly status: "queued" | "in_progress" | "completed";
+ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
/**
* @example neutral
* @enum {string|null}
@@ -25419,10 +26157,11 @@ export interface components {
*/
readonly head_sha: string;
/**
+ * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.
* @example completed
* @enum {string|null}
*/
- readonly status: "queued" | "in_progress" | "completed";
+ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
/**
* @example neutral
* @enum {string|null}
@@ -25460,21 +26199,6 @@ export interface components {
};
readonly repository: components["schemas"]["minimal-repository"];
};
- readonly "code-scanning-alert-rule-summary": {
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id?: string | null;
- /** @description The name of the rule used to detect the alert. */
- readonly name?: string;
- /** @description A set of tags applicable for the rule. */
- readonly tags?: string[] | null;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity?: "none" | "note" | "warning" | "error";
- /** @description A short description of the rule used to detect the alert. */
- readonly description?: string;
- };
readonly "code-scanning-alert-items": {
readonly number: components["schemas"]["alert-number"];
readonly created_at: components["schemas"]["alert-created-at"];
@@ -25492,6 +26216,32 @@ export interface components {
readonly tool: components["schemas"]["code-scanning-analysis-tool"];
readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
};
+ readonly "code-scanning-alert-rule": {
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id?: string | null;
+ /** @description The name of the rule used to detect the alert. */
+ readonly name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity?: "none" | "note" | "warning" | "error";
+ /**
+ * @description The security severity of the alert.
+ * @enum {string|null}
+ */
+ readonly security_severity_level?: "low" | "medium" | "high" | "critical";
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description?: string;
+ /** @description description of the rule used to detect the alert. */
+ readonly full_description?: string;
+ /** @description A set of tags applicable for the rule. */
+ readonly tags?: string[] | null;
+ /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */
+ readonly help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ readonly help_uri?: string | null;
+ };
readonly "code-scanning-alert": {
readonly number: components["schemas"]["alert-number"];
readonly created_at: components["schemas"]["alert-created-at"];
@@ -25659,7 +26409,7 @@ export interface components {
};
/**
* @description The full Git reference, formatted as `refs/heads/`,
- * `refs/pull//merge`, or `refs/pull//head`.
+ * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`.
* @example refs/heads/main
*/
readonly "code-scanning-ref-full": string;
@@ -27447,24 +28197,7 @@ export interface components {
* ]
*/
readonly events: string[];
- readonly config: {
- /** @example "foo@bar.com" */
- readonly email?: string;
- /** @example "foo" */
- readonly password?: string;
- /** @example "roomer" */
- readonly room?: string;
- /** @example "foo" */
- readonly subdomain?: string;
- readonly url?: components["schemas"]["webhook-config-url"];
- readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
- readonly content_type?: components["schemas"]["webhook-config-content-type"];
- /** @example "sha256" */
- readonly digest?: string;
- readonly secret?: components["schemas"]["webhook-config-secret"];
- /** @example "abc" */
- readonly token?: string;
- };
+ readonly config: components["schemas"]["webhook-config"];
/**
* Format: date-time
* @example 2011-09-06T20:39:23Z
@@ -28772,10 +29505,12 @@ export interface components {
* @description The GitHub Pages deployment status.
*/
readonly "page-deployment": {
+ /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */
+ readonly id: number | string;
/**
* Format: uri
* @description The URI to monitor GitHub Pages deployment status.
- * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status
+ * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251
*/
readonly status_url: string;
/**
@@ -28791,6 +29526,14 @@ export interface components {
*/
readonly preview_url?: string;
};
+ /** GitHub Pages deployment status */
+ readonly "pages-deployment-status": {
+ /**
+ * @description The current status of the deployment.
+ * @enum {string}
+ */
+ readonly status?: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed";
+ };
/**
* Pages Health Check Status
* @description Pages Health Check Status
@@ -29728,6 +30471,42 @@ export interface components {
/** @description The API URL to get the associated commit resource */
readonly commit_url: string;
};
+ /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */
+ readonly "secret-scanning-location-wiki-commit": {
+ /**
+ * @description The file path of the wiki page
+ * @example /example/Home.md
+ */
+ readonly path: string;
+ /** @description Line number at which the secret starts in the file */
+ readonly start_line: number;
+ /** @description Line number at which the secret ends in the file */
+ readonly end_line: number;
+ /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */
+ readonly start_column: number;
+ /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */
+ readonly end_column: number;
+ /**
+ * @description SHA-1 hash ID of the associated blob
+ * @example af5626b4a114abcb82d63db7c8082c3c4756e51b
+ */
+ readonly blob_sha: string;
+ /**
+ * @description The GitHub URL to get the associated wiki page
+ * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5
+ */
+ readonly page_url: string;
+ /**
+ * @description SHA-1 hash ID of the associated commit
+ * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5
+ */
+ readonly commit_sha: string;
+ /**
+ * @description The GitHub URL to get the associated wiki commit
+ * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5
+ */
+ readonly commit_url: string;
+ };
/** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */
readonly "secret-scanning-location-issue-title": {
/**
@@ -29755,14 +30534,86 @@ export interface components {
*/
readonly issue_comment_url: string;
};
+ /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */
+ readonly "secret-scanning-location-discussion-title": {
+ /**
+ * Format: uri
+ * @description The URL to the discussion where the secret was detected.
+ * @example https://github.com/community/community/discussions/39082
+ */
+ readonly discussion_title_url: string;
+ };
+ /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */
+ readonly "secret-scanning-location-discussion-body": {
+ /**
+ * Format: uri
+ * @description The URL to the discussion where the secret was detected.
+ * @example https://github.com/community/community/discussions/39082#discussion-4566270
+ */
+ readonly discussion_body_url: string;
+ };
+ /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */
+ readonly "secret-scanning-location-discussion-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the discussion comment where the secret was detected.
+ * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232
+ */
+ readonly discussion_comment_url: string;
+ };
+ /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */
+ readonly "secret-scanning-location-pull-request-title": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pull/2846
+ */
+ readonly pull_request_title_url: string;
+ };
+ /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */
+ readonly "secret-scanning-location-pull-request-body": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pull/2846
+ */
+ readonly pull_request_body_url: string;
+ };
+ /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */
+ readonly "secret-scanning-location-pull-request-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request comment where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
+ */
+ readonly pull_request_comment_url: string;
+ };
+ /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */
+ readonly "secret-scanning-location-pull-request-review": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request review where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
+ */
+ readonly pull_request_review_url: string;
+ };
+ /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */
+ readonly "secret-scanning-location-pull-request-review-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request review comment where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12
+ */
+ readonly pull_request_review_comment_url: string;
+ };
readonly "secret-scanning-location": {
/**
- * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found.
+ * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.
* @example commit
* @enum {string}
*/
- readonly type: "commit" | "issue_title" | "issue_body" | "issue_comment";
- readonly 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"];
+ readonly type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment";
+ readonly details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"];
};
readonly "repository-advisory-create": {
/** @description A short summary of the advisory. */
@@ -29801,6 +30652,11 @@ export interface components {
readonly severity?: "critical" | "high" | "medium" | "low";
/** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */
readonly cvss_vector_string?: string | null;
+ /**
+ * @description Whether to create a temporary private fork of the repository to collaborate on a fix.
+ * @default false
+ */
+ readonly start_private_fork: boolean;
};
readonly "private-vulnerability-report-create": {
/** @description A short summary of the advisory. */
@@ -29831,6 +30687,11 @@ export interface components {
readonly severity?: "critical" | "high" | "medium" | "low";
/** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */
readonly cvss_vector_string?: string | null;
+ /**
+ * @description Whether to create a temporary private fork of the repository to collaborate on a fix.
+ * @default false
+ */
+ readonly start_private_fork: boolean;
};
readonly "repository-advisory-update": {
/** @description A short summary of the advisory. */
@@ -31311,7 +32172,7 @@ export interface components {
/** @example 80 */
readonly watchers_count: number;
/**
- * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
* @example 108
*/
readonly size: number;
@@ -31698,6 +32559,50 @@ export interface components {
/** @example "2020-07-09T00:17:55Z" */
readonly starred_at?: string;
};
+ /**
+ * branch protection rule
+ * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.
+ */
+ readonly webhooks_rule: {
+ readonly admin_enforced: boolean;
+ /** @enum {string} */
+ readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone";
+ /** @enum {string} */
+ readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone";
+ readonly authorized_actor_names: string[];
+ readonly authorized_actors_only: boolean;
+ readonly authorized_dismissal_actors_only: boolean;
+ readonly create_protected?: boolean;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly dismiss_stale_reviews_on_push: boolean;
+ readonly id: number;
+ readonly ignore_approvals_from_contributors: boolean;
+ /** @enum {string} */
+ readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone";
+ /** @enum {string} */
+ readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone";
+ readonly name: string;
+ /** @enum {string} */
+ readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone";
+ readonly repository_id: number;
+ readonly require_code_owner_review: boolean;
+ /** @description Whether the most recent push must be approved by someone other than the person who pushed it */
+ readonly require_last_push_approval?: boolean;
+ readonly required_approving_review_count: number;
+ /** @enum {string} */
+ readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone";
+ /** @enum {string} */
+ readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone";
+ readonly required_status_checks: string[];
+ /** @enum {string} */
+ readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone";
+ /** @enum {string} */
+ readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone";
+ readonly strict_required_status_checks_policy: boolean;
+ /** Format: date-time */
+ readonly updated_at: string;
+ };
/** @description A suite of checks performed on the code of a given code change */
readonly "simple-check-suite": {
/** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */
@@ -31799,15 +32704,68 @@ export interface components {
/** @example https://api.github.com/repos/github/hello-world/check-runs/4 */
readonly url: string;
};
- /**
- * Discussion
- * @description A Discussion in a repository.
- */
- readonly discussion: {
- readonly active_lock_reason: string | null;
- readonly answer_chosen_at: string | null;
+ /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
+ readonly webhooks_code_scanning_commit_oid: string;
+ /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
+ readonly webhooks_code_scanning_ref: string;
+ /** @description The pusher type for the event. Can be either `user` or a deploy key. */
+ readonly webhooks_deploy_pusher_type: string;
+ /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */
+ readonly webhooks_ref_0: string;
+ /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */
+ readonly webhooks_deploy_key: {
+ readonly added_by?: string | null;
+ readonly created_at: string;
+ readonly id: number;
+ readonly key: string;
+ readonly last_used?: string | null;
+ readonly read_only: boolean;
+ readonly title: string;
+ /** Format: uri */
+ readonly url: string;
+ readonly verified: boolean;
+ };
+ /** Workflow */
+ readonly webhooks_workflow: {
+ /** Format: uri */
+ readonly badge_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string;
+ readonly node_id: string;
+ readonly path: string;
+ readonly state: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ readonly webhooks_approver: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
+ readonly webhooks_reviewers: {
/** User */
- readonly answer_chosen_by: {
+ readonly reviewer?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -31843,7 +32801,57 @@ export interface components {
/** Format: uri */
readonly url?: string;
} | null;
- readonly answer_html_url: string | null;
+ /** @enum {string} */
+ readonly type?: "User";
+ }[];
+ readonly webhooks_workflow_job_run: {
+ readonly conclusion: unknown;
+ readonly created_at: string;
+ readonly environment: string;
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: unknown;
+ readonly status: string;
+ readonly updated_at: string;
+ };
+ /** User */
+ readonly webhooks_user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly webhooks_answer: {
/**
* AuthorAssociation
* @description How the author is associated with the repository.
@@ -31851,27 +32859,14 @@ export interface components {
*/
readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
readonly body: string;
- readonly category: {
- /** Format: date-time */
- readonly created_at: string;
- readonly description: string;
- readonly emoji: string;
- readonly id: number;
- readonly is_answerable: boolean;
- readonly name: string;
- readonly node_id?: string;
- readonly repository_id: number;
- readonly slug: string;
- readonly updated_at: string;
- };
- readonly comments: number;
+ readonly child_comment_count: number;
/** Format: date-time */
readonly created_at: string;
+ readonly discussion_id: number;
readonly html_url: string;
readonly id: number;
- readonly locked: boolean;
readonly node_id: string;
- readonly number: number;
+ readonly parent_id: unknown;
/** Reactions */
readonly reactions?: {
readonly "+1": number;
@@ -31887,21 +32882,6 @@ export interface components {
readonly url: string;
};
readonly repository_url: string;
- /**
- * @description The current state of the discussion.
- * `converting` means that the discussion is being converted from an issue.
- * `transferring` means that the discussion is being transferred from another repository.
- * @enum {string}
- */
- readonly state: "open" | "closed" | "locked" | "converting" | "transferring";
- /**
- * @description The reason for the current state
- * @example resolved
- * @enum {string|null}
- */
- readonly state_reason: "resolved" | "outdated" | "duplicate" | "reopened";
- readonly timeline_url?: string;
- readonly title: string;
/** Format: date-time */
readonly updated_at: string;
/** User */
@@ -31943,11797 +32923,2518 @@ export interface components {
} | null;
};
/**
- * Merge Group
- * @description A group of pull requests that the merge queue has grouped together to be merged.
- *
- */
- readonly "merge-group": {
- /** @description The SHA of the merge group. */
- readonly head_sha: string;
- /** @description The full ref of the merge group. */
- readonly head_ref: string;
- /** @description The SHA of the merge group's parent commit. */
- readonly base_sha: string;
- /** @description The full ref of the branch the merge group will be merged into. */
- readonly base_ref: string;
- readonly head_commit: components["schemas"]["simple-commit"];
- };
- /**
- * Repository
- * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
- * when the event occurs from activity in a repository.
+ * Discussion
+ * @description A Discussion in a repository.
*/
- readonly "nullable-repository-webhooks": {
+ readonly discussion: {
+ readonly active_lock_reason: string | null;
+ readonly answer_chosen_at: string | null;
+ /** User */
+ readonly answer_chosen_by: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly answer_html_url: string | null;
/**
- * @description Unique identifier of the repository
- * @example 42
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
*/
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ readonly body: string;
+ readonly category: {
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly description: string;
+ readonly emoji: string;
+ readonly id: number;
+ readonly is_answerable: boolean;
+ readonly name: string;
+ readonly node_id?: string;
+ readonly repository_id: number;
+ readonly slug: string;
+ readonly updated_at: string;
+ };
+ readonly comments: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly html_url: string;
readonly id: number;
- /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ readonly locked: boolean;
readonly node_id: string;
+ readonly number: number;
+ /** Reactions */
+ readonly reactions?: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly repository_url: string;
/**
- * @description The name of the repository.
- * @example Team Environment
+ * @description The current state of the discussion.
+ * `converting` means that the discussion is being converted from an issue.
+ * `transferring` means that the discussion is being transferred from another repository.
+ * @enum {string}
*/
- readonly name: string;
- /** @example octocat/Hello-World */
- readonly full_name: string;
- readonly license: components["schemas"]["nullable-license-simple"];
- readonly organization?: components["schemas"]["nullable-simple-user"];
- readonly forks: number;
- readonly permissions?: {
- readonly admin: boolean;
- readonly pull: boolean;
- readonly triage?: boolean;
- readonly push: boolean;
- readonly maintain?: boolean;
- };
- readonly owner: components["schemas"]["simple-user"];
+ readonly state: "open" | "closed" | "locked" | "converting" | "transferring";
/**
- * @description Whether the repository is private or public.
- * @default false
+ * @description The reason for the current state
+ * @example resolved
+ * @enum {string|null}
*/
- readonly private: boolean;
+ readonly state_reason: "resolved" | "outdated" | "duplicate" | "reopened";
+ readonly timeline_url?: string;
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ readonly webhooks_comment: {
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
*/
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ readonly body: string;
+ readonly child_comment_count: number;
+ readonly created_at: string;
+ readonly discussion_id: number;
readonly html_url: string;
- /** @example This your first repo! */
+ readonly id: number;
+ readonly node_id: string;
+ readonly parent_id: number | null;
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly repository_url: string;
+ readonly updated_at: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ /** Label */
+ readonly webhooks_label: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
readonly description: string | null;
- readonly fork: boolean;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World
+ * @description URL for the label
*/
readonly url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
- readonly archive_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
- readonly assignees_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
- readonly blobs_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
- readonly branches_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
- readonly collaborators_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
- readonly comments_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
- readonly commits_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
- readonly compare_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
- readonly contents_url: string;
+ };
+ /** @description An array of repository objects that the installation can access. */
+ readonly webhooks_repositories: {
+ readonly full_name: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ }[];
+ /** @description An array of repository objects, which were added to the installation. */
+ readonly webhooks_repositories_added: {
+ readonly full_name: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ }[];
+ /**
+ * @description Describe whether all repositories have been selected or there's a selection involved
+ * @enum {string}
+ */
+ readonly webhooks_repository_selection: "all" | "selected";
+ /**
+ * issue comment
+ * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
+ */
+ readonly webhooks_issue_comment: {
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/contributors
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
*/
- readonly contributors_url: string;
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue comment */
+ readonly body: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** Format: uri */
+ readonly html_url: string;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/deployments
+ * Format: int64
+ * @description Unique identifier of the issue comment
*/
- readonly deployments_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly issue_url: string;
+ readonly node_id: string;
+ readonly performed_via_github_app: components["schemas"]["integration"];
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Format: date-time */
+ readonly updated_at: string;
/**
* Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/downloads
+ * @description URL for the issue comment
*/
- readonly downloads_url: string;
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ /** @description The changes to the comment. */
+ readonly webhooks_changes: {
+ readonly body?: {
+ /** @description The previous version of the body. */
+ readonly from: string;
+ };
+ };
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ readonly webhooks_issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ /** User */
+ readonly assignee?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/events
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
*/
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
readonly events_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/forks
- */
- readonly forks_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
- readonly git_commits_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
- readonly git_refs_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
- readonly git_tags_url: string;
- /** @example git:github.com/octocat/Hello-World.git */
- readonly git_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
- readonly issue_comment_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
- readonly issue_events_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
- readonly issues_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
- readonly keys_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
readonly labels_url: string;
+ readonly locked?: boolean;
/**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/languages
- */
- readonly languages_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/merges
+ * Milestone
+ * @description A collection of related issues and pull requests.
*/
- readonly merges_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
- readonly milestones_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
- readonly notifications_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
- readonly pulls_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
- readonly releases_url: string;
- /** @example git@github.com:octocat/Hello-World.git */
- readonly ssh_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/stargazers
- */
- readonly stargazers_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
- readonly statuses_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/subscribers
- */
- readonly subscribers_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/subscription
- */
- readonly subscription_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/tags
- */
- readonly tags_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/teams
- */
- readonly teams_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
- readonly trees_url: string;
- /** @example https://github.com/octocat/Hello-World.git */
- readonly clone_url: string;
- /**
- * Format: uri
- * @example git:git.example.com/octocat/Hello-World
- */
- readonly mirror_url: string | null;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/hooks
- */
- readonly hooks_url: string;
- /**
- * Format: uri
- * @example https://svn.github.com/octocat/Hello-World
- */
- readonly svn_url: string;
- /**
- * Format: uri
- * @example https://github.com
- */
- readonly homepage: string | null;
- readonly language: string | null;
- /** @example 9 */
- readonly forks_count: number;
- /** @example 80 */
- readonly stargazers_count: number;
- /** @example 80 */
- readonly watchers_count: number;
- /**
- * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- * @example 108
- */
- readonly size: number;
- /**
- * @description The default branch of the repository.
- * @example master
- */
- readonly default_branch: string;
- /** @example 0 */
- readonly open_issues_count: number;
- /**
- * @description Whether this repository acts as a template that can be used to generate new repositories.
- * @default false
- * @example true
- */
- readonly is_template: boolean;
- readonly topics?: string[];
- /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
- };
- /**
- * @description Whether issues are enabled.
- * @default true
- * @example true
- */
- readonly has_issues: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- * @example true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- * @example true
- */
- readonly has_wiki: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether downloads are enabled.
- * @default true
- * @example true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- * @example true
- */
- readonly has_discussions: boolean;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
- /** @description Returns whether or not this repository disabled. */
- readonly disabled: boolean;
- /**
- * @description The repository visibility: public, private, or internal.
- * @default public
- */
- readonly visibility: string;
- /**
- * Format: date-time
- * @example 2011-01-26T19:06:43Z
- */
- readonly pushed_at: string | null;
- /**
- * Format: date-time
- * @example 2011-01-26T19:01:12Z
- */
- readonly created_at: string | null;
- /**
- * Format: date-time
- * @example 2011-01-26T19:14:43Z
- */
- readonly updated_at: string | null;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- * @example true
- */
- readonly allow_rebase_merge: boolean;
- readonly template_repository?: {
- readonly id?: number;
- readonly node_id?: string;
- readonly name?: string;
- readonly full_name?: string;
- readonly owner?: {
- readonly login?: string;
- readonly id?: number;
- readonly node_id?: string;
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
readonly avatar_url?: string;
- readonly gravatar_id?: string;
- readonly url?: string;
- readonly html_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
readonly followers_url?: string;
+ /** Format: uri-template */
readonly following_url?: string;
+ /** Format: uri-template */
readonly gists_url?: string;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
readonly organizations_url?: string;
- readonly repos_url?: string;
- readonly events_url?: string;
+ /** Format: uri */
readonly received_events_url?: string;
- readonly type?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
readonly site_admin?: boolean;
- };
- readonly private?: boolean;
- readonly html_url?: string;
- readonly description?: string;
- readonly fork?: boolean;
- readonly url?: string;
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly forks_url?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly git_url?: string;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly notifications_url?: string;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly ssh_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly clone_url?: string;
- readonly mirror_url?: string;
- readonly hooks_url?: string;
- readonly svn_url?: string;
- readonly homepage?: string;
- readonly language?: string;
- readonly forks_count?: number;
- readonly stargazers_count?: number;
- readonly watchers_count?: number;
- readonly size?: number;
- readonly default_branch?: string;
- readonly open_issues_count?: number;
- readonly is_template?: boolean;
- readonly topics?: string[];
- readonly has_issues?: boolean;
- readonly has_projects?: boolean;
- readonly has_wiki?: boolean;
- readonly has_pages?: boolean;
- readonly has_downloads?: boolean;
- readonly archived?: boolean;
- readonly disabled?: boolean;
- readonly visibility?: string;
- readonly pushed_at?: string;
- readonly created_at?: string;
- readonly updated_at?: string;
- readonly permissions?: {
- readonly admin?: boolean;
- readonly maintain?: boolean;
- readonly push?: boolean;
- readonly triage?: boolean;
- readonly pull?: boolean;
- };
- readonly allow_rebase_merge?: boolean;
- readonly temp_clone_token?: string;
- readonly allow_squash_merge?: boolean;
- readonly allow_auto_merge?: boolean;
- readonly delete_branch_on_merge?: boolean;
- readonly allow_update_branch?: boolean;
- readonly use_squash_pr_title_as_default?: boolean;
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
/**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
+ * @description The state of the milestone.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- readonly allow_merge_commit?: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
} | null;
- readonly temp_clone_token?: string;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- * @example true
- */
- readonly allow_squash_merge: boolean;
- /**
- * @description Whether to allow Auto-merge to be used on pull requests.
- * @default false
- * @example false
- */
- readonly allow_auto_merge: boolean;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- * @example false
- */
- readonly delete_branch_on_merge: boolean;
- /**
- * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- * @default false
- * @example false
- */
- readonly allow_update_branch: boolean;
- /**
- * @deprecated
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
- */
- readonly use_squash_pr_title_as_default: boolean;
+ readonly node_id: string;
+ readonly number: number;
/**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Format: uri */
+ readonly repository_url: string;
/**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
+ * @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
/**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
+ * Format: uri
+ * @description URL for the issue
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- * @example true
- */
- readonly allow_merge_commit: boolean;
- /** @description Whether to allow forking this repo */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to require contributors to sign off on web-based commits
- * @default false
- */
- readonly web_commit_signoff_required: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
- readonly open_issues: number;
- readonly watchers: number;
- readonly master_branch?: string;
- /** @example "2020-07-09T00:17:42Z" */
- readonly starred_at?: string;
- /** @description Whether anonymous git access is enabled for this repository */
- readonly anonymous_access_enabled?: boolean;
- } | null;
- /**
- * Personal Access Token Request
- * @description Details of a Personal Access Token Request.
- */
- readonly "personal-access-token-request": {
- /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */
- readonly id: number;
- readonly owner: components["schemas"]["simple-user"];
- /** @description New requested permissions, categorized by type of permission. */
- readonly permissions_added: {
- readonly organization?: {
- readonly [key: string]: string | undefined;
- };
- readonly repository?: {
- readonly [key: string]: string | undefined;
- };
- readonly other?: {
- readonly [key: string]: string | undefined;
- };
- };
- /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */
- readonly permissions_upgraded: {
- readonly organization?: {
- readonly [key: string]: string | undefined;
- };
- readonly repository?: {
- readonly [key: string]: string | undefined;
- };
- readonly other?: {
- readonly [key: string]: string | undefined;
- };
- };
- /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */
- readonly permissions_result: {
- readonly organization?: {
- readonly [key: string]: string | undefined;
- };
- readonly repository?: {
- readonly [key: string]: string | undefined;
- };
- readonly other?: {
- readonly [key: string]: string | undefined;
- };
- };
- /**
- * @description Type of repository selection requested.
- * @enum {string}
- */
- readonly repository_selection: "none" | "all" | "subset";
- /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */
- readonly repository_count: number | null;
- /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */
- readonly repositories: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[] | null;
- /** @description Date and time when the request for access was created. */
- readonly created_at: string;
- /** @description Whether the associated fine-grained personal access token has expired. */
- readonly token_expired: boolean;
- /** @description Date and time when the associated fine-grained personal access token expires. */
- readonly token_expires_at: string | null;
- /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */
- readonly token_last_used_at: string | null;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
};
/**
- * Projects v2 Project
- * @description A projects v2 project
+ * Milestone
+ * @description A collection of related issues and pull requests.
*/
- readonly "projects-v2": {
- readonly id: number;
- readonly node_id: string;
- readonly owner: components["schemas"]["simple-user"];
- readonly creator: components["schemas"]["simple-user"];
- readonly title: string;
- readonly description: string | null;
- readonly public: boolean;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
+ readonly webhooks_milestone: {
+ /** Format: date-time */
readonly closed_at: string | null;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
+ readonly closed_issues: number;
+ /** Format: date-time */
readonly created_at: string;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
- readonly updated_at: string;
- readonly number: number;
- readonly short_description: string | null;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
- readonly deleted_at: string | null;
- readonly deleted_by: components["schemas"]["nullable-simple-user"];
- };
- /**
- * Projects v2 Item Content Type
- * @description The type of content tracked in a project item
- * @enum {string}
- */
- readonly "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue";
- /**
- * Projects v2 Item
- * @description An item belonging to a project
- */
- readonly "projects-v2-item": {
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
readonly id: number;
- readonly node_id?: string;
- readonly project_node_id?: string;
- readonly content_node_id: string;
- readonly content_type: components["schemas"]["projects-v2-item-content-type"];
- readonly creator?: components["schemas"]["simple-user"];
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
- readonly created_at: string;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
/**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
+ * @description The state of the milestone.
+ * @enum {string}
*/
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
readonly updated_at: string;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
- readonly archived_at: string | null;
+ /** Format: uri */
+ readonly url: string;
};
/**
- * @description The reason for resolving the alert.
- * @enum {string|null}
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited";
- readonly "secret-scanning-alert-webhook": {
- readonly number?: components["schemas"]["alert-number"];
- readonly created_at?: components["schemas"]["alert-created-at"];
- readonly updated_at?: components["schemas"]["nullable-alert-updated-at"];
- readonly url?: components["schemas"]["alert-url"];
- readonly html_url?: components["schemas"]["alert-html-url"];
- /**
- * Format: uri
- * @description The REST API URL of the code locations for this alert.
- */
- readonly locations_url?: string;
- readonly resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"];
- /**
- * Format: date-time
- * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- readonly resolved_at?: string | null;
- readonly resolved_by?: components["schemas"]["nullable-simple-user"];
- /** @description An optional comment to resolve an alert. */
- readonly resolution_comment?: string | null;
- /** @description The type of secret that secret scanning detected. */
- readonly secret_type?: string;
- /** @description Whether push protection was bypassed for the detected secret. */
- readonly push_protection_bypassed?: boolean | null;
- readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"];
- /**
- * Format: date-time
- * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- readonly push_protection_bypassed_at?: string | null;
- };
- /** branch protection configuration disabled event */
- readonly "webhook-branch-protection-configuration-disabled": {
- /** @enum {string} */
- readonly action: "disabled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** branch protection configuration enabled event */
- readonly "webhook-branch-protection-configuration-enabled": {
- /** @enum {string} */
- readonly action: "enabled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** branch protection rule created event */
- readonly "webhook-branch-protection-rule-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- /**
- * branch protection rule
- * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.
- */
- readonly rule: {
- readonly admin_enforced: boolean;
- /** @enum {string} */
- readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone";
- readonly authorized_actor_names: string[];
- readonly authorized_actors_only: boolean;
- readonly authorized_dismissal_actors_only: boolean;
- readonly create_protected?: boolean;
- /** Format: date-time */
- readonly created_at: string;
- readonly dismiss_stale_reviews_on_push: boolean;
+ readonly webhooks_issue_2: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ /** User */
+ readonly assignee?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
- readonly ignore_approvals_from_contributors: boolean;
- /** @enum {string} */
- readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone";
- readonly name: string;
- /** @enum {string} */
- readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone";
- readonly repository_id: number;
- readonly require_code_owner_review: boolean;
- /** @description Whether the most recent push must be approved by someone other than the person who pushed it */
- readonly require_last_push_approval?: boolean;
- readonly required_approving_review_count: number;
- /** @enum {string} */
- readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone";
- readonly required_status_checks: string[];
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
/** @enum {string} */
- readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone";
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
/** @enum {string} */
- readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone";
- readonly strict_required_status_checks_policy: boolean;
- /** Format: date-time */
- readonly updated_at: string;
- };
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** branch protection rule deleted event */
- readonly "webhook-branch-protection-rule-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
/**
- * branch protection rule
- * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
*/
- readonly rule: {
- readonly admin_enforced: boolean;
- /** @enum {string} */
- readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone";
- readonly authorized_actor_names: string[];
- readonly authorized_actors_only: boolean;
- readonly authorized_dismissal_actors_only: boolean;
- readonly create_protected?: boolean;
- /** Format: date-time */
- readonly created_at: string;
- readonly dismiss_stale_reviews_on_push: boolean;
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
readonly id: number;
- readonly ignore_approvals_from_contributors: boolean;
- /** @enum {string} */
- readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone";
+ /** @description The name of the label. */
readonly name: string;
- /** @enum {string} */
- readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone";
- readonly repository_id: number;
- readonly require_code_owner_review: boolean;
- /** @description Whether the most recent push must be approved by someone other than the person who pushed it */
- readonly require_last_push_approval?: boolean;
- readonly required_approving_review_count: number;
- /** @enum {string} */
- readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone";
- readonly required_status_checks: string[];
- /** @enum {string} */
- readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone";
- readonly strict_required_status_checks_policy: boolean;
- /** Format: date-time */
- readonly updated_at: string;
- };
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** branch protection rule edited event */
- readonly "webhook-branch-protection-rule-edited": {
- /** @enum {string} */
- readonly action: "edited";
- /** @description If the action was `edited`, the changes to the rule. */
- readonly changes?: {
- readonly admin_enforced?: {
- readonly from: boolean | null;
- };
- readonly authorized_actor_names?: {
- readonly from: string[];
- };
- readonly authorized_actors_only?: {
- readonly from: boolean | null;
- };
- readonly authorized_dismissal_actors_only?: {
- readonly from: boolean | null;
- };
- readonly linear_history_requirement_enforcement_level?: {
- /** @enum {string} */
- readonly from: "off" | "non_admins" | "everyone";
- };
- readonly required_status_checks?: {
- readonly from: string[];
- };
- readonly required_status_checks_enforcement_level?: {
- /** @enum {string} */
- readonly from: "off" | "non_admins" | "everyone";
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
/**
- * branch protection rule
- * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.
+ * Milestone
+ * @description A collection of related issues and pull requests.
*/
- readonly rule: {
- readonly admin_enforced: boolean;
- /** @enum {string} */
- readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone";
- readonly authorized_actor_names: string[];
- readonly authorized_actors_only: boolean;
- readonly authorized_dismissal_actors_only: boolean;
- readonly create_protected?: boolean;
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
/** Format: date-time */
readonly created_at: string;
- readonly dismiss_stale_reviews_on_push: boolean;
- readonly id: number;
- readonly ignore_approvals_from_contributors: boolean;
- /** @enum {string} */
- readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone";
- readonly name: string;
- /** @enum {string} */
- readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone";
- readonly repository_id: number;
- readonly require_code_owner_review: boolean;
- /** @description Whether the most recent push must be approved by someone other than the person who pushed it */
- readonly require_last_push_approval?: boolean;
- readonly required_approving_review_count: number;
- /** @enum {string} */
- readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone";
- readonly required_status_checks: string[];
- /** @enum {string} */
- readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone";
- /** @enum {string} */
- readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone";
- readonly strict_required_status_checks_policy: boolean;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
/** Format: date-time */
readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ readonly node_id: string;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
};
- readonly sender: components["schemas"]["simple-user-webhooks"];
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Format: uri */
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
};
- /** Check Run Completed Event */
- readonly "webhook-check-run-completed": {
+ /** User */
+ readonly webhooks_user_mannequin: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
/** @enum {string} */
- readonly action?: "completed";
- readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /**
- * Check Run Completed Event
- * @description The check_run.completed webhook encoded with URL encoding
- */
- readonly "webhook-check-run-completed-form-encoded": {
- /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** Marketplace Purchase */
+ readonly webhooks_marketplace_purchase: {
+ readonly account: {
+ readonly id: number;
+ readonly login: string;
+ readonly node_id: string;
+ readonly organization_billing_email: string | null;
+ readonly type: string;
+ };
+ readonly billing_cycle: string;
+ readonly free_trial_ends_on: string | null;
+ readonly next_billing_date: string | null;
+ readonly on_free_trial: boolean;
+ readonly plan: {
+ readonly bullets: (string | null)[];
+ readonly description: string;
+ readonly has_free_trial: boolean;
+ readonly id: number;
+ readonly monthly_price_in_cents: number;
+ readonly name: string;
+ /** @enum {string} */
+ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ readonly unit_name: string | null;
+ readonly yearly_price_in_cents: number;
+ };
+ readonly unit_count: number;
};
- /** Check Run Created Event */
- readonly "webhook-check-run-created": {
- /** @enum {string} */
- readonly action?: "created";
- readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
+ /** Marketplace Purchase */
+ readonly webhooks_previous_marketplace_purchase: {
+ readonly account: {
+ readonly id: number;
+ readonly login: string;
+ readonly node_id: string;
+ readonly organization_billing_email: string | null;
+ readonly type: string;
+ };
+ readonly billing_cycle: string;
+ readonly free_trial_ends_on: unknown;
+ readonly next_billing_date?: string | null;
+ readonly on_free_trial: boolean;
+ readonly plan: {
+ readonly bullets: string[];
+ readonly description: string;
+ readonly has_free_trial: boolean;
+ readonly id: number;
+ readonly monthly_price_in_cents: number;
+ readonly name: string;
+ /** @enum {string} */
+ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ readonly unit_name: string | null;
+ readonly yearly_price_in_cents: number;
+ };
+ readonly unit_count: number;
};
/**
- * Check Run Created Event
- * @description The check_run.created webhook encoded with URL encoding
+ * Team
+ * @description Groups of organization members that gives permissions on specified repositories.
*/
- readonly "webhook-check-run-created-form-encoded": {
- /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
- };
- /** Check Run Requested Action Event */
- readonly "webhook-check-run-requested-action": {
+ readonly webhooks_team: {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ readonly notification_setting: "notifications_enabled" | "notifications_disabled";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
/** @enum {string} */
- readonly action: "requested_action";
- readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- /** @description The action requested by the user. */
- readonly requested_action?: {
- /** @description The integrator reference of the action requested by the user. */
- readonly identifier?: string;
- };
- readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly privacy?: "open" | "closed" | "secret";
+ /** @enum {string} */
+ readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
+ /** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url?: string;
};
/**
- * Check Run Requested Action Event
- * @description The check_run.requested_action webhook encoded with URL encoding
+ * Merge Group
+ * @description A group of pull requests that the merge queue has grouped together to be merged.
+ *
*/
- readonly "webhook-check-run-requested-action-form-encoded": {
- /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
- };
- /** Check Run Re-Requested Event */
- readonly "webhook-check-run-rerequested": {
- /** @enum {string} */
- readonly action?: "rerequested";
- readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly "merge-group": {
+ /** @description The SHA of the merge group. */
+ readonly head_sha: string;
+ /** @description The full ref of the merge group. */
+ readonly head_ref: string;
+ /** @description The SHA of the merge group's parent commit. */
+ readonly base_sha: string;
+ /** @description The full ref of the branch the merge group will be merged into. */
+ readonly base_ref: string;
+ readonly head_commit: components["schemas"]["simple-commit"];
};
/**
- * Check Run Re-Requested Event
- * @description The check_run.rerequested webhook encoded with URL encoding
+ * Repository
+ * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
+ * when the event occurs from activity in a repository.
*/
- readonly "webhook-check-run-rerequested-form-encoded": {
- /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
- };
- /** check_suite completed event */
- readonly "webhook-check-suite-completed": {
- /** @enum {string} */
- readonly action: "completed";
- /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
- readonly check_suite: {
- readonly after: string | null;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly app: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- };
- readonly before: string | null;
- /** Format: uri */
- readonly check_runs_url: string;
- /**
- * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.
- * @enum {string|null}
- */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure";
- /** Format: date-time */
- readonly created_at: string;
- /** @description The head branch name the changes are on. */
- readonly head_branch: string | null;
- /** SimpleCommit */
- readonly head_commit: {
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly author: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly committer: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- readonly id: string;
- readonly message: string;
- readonly timestamp: string;
- readonly tree_id: string;
- };
- /** @description The SHA of the head commit that is being checked. */
- readonly head_sha: string;
- readonly id: number;
- readonly latest_check_runs_count: number;
- readonly node_id: string;
- /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly rerequestable?: boolean;
- readonly runs_rerequestable?: boolean;
- /**
- * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
- * @enum {string|null}
- */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | null | "pending";
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL that points to the check suite API resource.
- */
- readonly url: string;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** check_suite requested event */
- readonly "webhook-check-suite-requested": {
- /** @enum {string} */
- readonly action: "requested";
- /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
- readonly check_suite: {
- readonly after: string | null;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly app: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- };
- readonly before: string | null;
- /** Format: uri */
- readonly check_runs_url: string;
- /**
- * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.
- * @enum {string|null}
- */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped";
- /** Format: date-time */
- readonly created_at: string;
- /** @description The head branch name the changes are on. */
- readonly head_branch: string | null;
- /** SimpleCommit */
- readonly head_commit: {
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly author: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly committer: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- readonly id: string;
- readonly message: string;
- readonly timestamp: string;
- readonly tree_id: string;
- };
- /** @description The SHA of the head commit that is being checked. */
- readonly head_sha: string;
- readonly id: number;
- readonly latest_check_runs_count: number;
- readonly node_id: string;
- /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly rerequestable?: boolean;
- readonly runs_rerequestable?: boolean;
- /**
- * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
- * @enum {string|null}
- */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | null;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL that points to the check suite API resource.
- */
- readonly url: string;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** check_suite rerequested event */
- readonly "webhook-check-suite-rerequested": {
- /** @enum {string} */
- readonly action: "rerequested";
- /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
- readonly check_suite: {
- readonly after: string | null;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly app: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- };
- readonly before: string | null;
- /** Format: uri */
- readonly check_runs_url: string;
- /**
- * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.
- * @enum {string|null}
- */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
- /** Format: date-time */
- readonly created_at: string;
- /** @description The head branch name the changes are on. */
- readonly head_branch: string | null;
- /** SimpleCommit */
- readonly head_commit: {
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly author: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- /**
- * Committer
- * @description Metaproperties for Git author/committer information.
- */
- readonly committer: {
- /** Format: date-time */
- readonly date?: string;
- /** Format: email */
- readonly email: string | null;
- /** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
- };
- readonly id: string;
- readonly message: string;
- readonly timestamp: string;
- readonly tree_id: string;
- };
- /** @description The SHA of the head commit that is being checked. */
- readonly head_sha: string;
- readonly id: number;
- readonly latest_check_runs_count: number;
- readonly node_id: string;
- /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly rerequestable?: boolean;
- readonly runs_rerequestable?: boolean;
- /**
- * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
- * @enum {string|null}
- */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | null;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL that points to the check suite API resource.
- */
- readonly url: string;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** code_scanning_alert appeared_in_branch event */
- readonly "webhook-code-scanning-alert-appeared-in-branch": {
- /** @enum {string} */
- readonly action: "appeared_in_branch";
- /** @description The code scanning alert involved in the event. */
- readonly alert: {
- /**
- * Format: date-time
- * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- readonly dismissed_at: string | null;
- /** User */
- readonly dismissed_by: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * @description The reason for dismissing or closing the alert.
- * @enum {string|null}
- */
- readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
- /**
- * Format: uri
- * @description The GitHub URL of the alert resource.
- */
- readonly html_url: string;
- /** Alert Instance */
- readonly most_recent_instance?: {
- /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
- /** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: string[];
- readonly commit_sha?: string;
- /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
- };
- readonly message?: {
- readonly text?: string;
- };
- /** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- } | null;
- /** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
- /** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity: "none" | "note" | "warning" | "error" | null;
- };
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- readonly tool: {
- /** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
- /** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
- };
- /** Format: uri */
- readonly url: string;
- };
- /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly commit_oid: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly ref: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** code_scanning_alert closed_by_user event */
- readonly "webhook-code-scanning-alert-closed-by-user": {
- /** @enum {string} */
- readonly action: "closed_by_user";
- /** @description The code scanning alert involved in the event. */
- readonly alert: {
- /**
- * Format: date-time
- * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- readonly dismissed_at: string;
- /** User */
- readonly dismissed_by: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * @description The reason for dismissing or closing the alert.
- * @enum {string|null}
- */
- readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
- /**
- * Format: uri
- * @description The GitHub URL of the alert resource.
- */
- readonly html_url: string;
- /** Alert Instance */
- readonly most_recent_instance?: {
- /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
- /** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: string[];
- readonly commit_sha?: string;
- /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
- };
- readonly message?: {
- readonly text?: string;
- };
- /** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- } | null;
- /** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
- /** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- readonly full_description?: string;
- readonly help?: string | null;
- /** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- readonly name?: string;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity: "none" | "note" | "warning" | "error" | null;
- readonly tags?: string[] | null;
- };
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "dismissed" | "fixed";
- readonly tool: {
- readonly guid?: string | null;
- /** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
- /** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
- };
- /** Format: uri */
- readonly url: string;
- };
- /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly commit_oid: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly ref: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** code_scanning_alert created event */
- readonly "webhook-code-scanning-alert-created": {
- /** @enum {string} */
- readonly action: "created";
- /** @description The code scanning alert involved in the event. */
- readonly alert: {
- /**
- * Format: date-time
- * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
- */
- readonly created_at: string | null;
- /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly dismissed_at: unknown;
- readonly dismissed_by: unknown;
- readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
- /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
- readonly dismissed_reason: unknown;
- readonly fixed_at?: unknown;
- /**
- * Format: uri
- * @description The GitHub URL of the alert resource.
- */
- readonly html_url: string;
- readonly instances_url?: string;
- /** Alert Instance */
- readonly most_recent_instance?: {
- /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
- /** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: string[];
- readonly commit_sha?: string;
- /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
- };
- readonly message?: {
- readonly text?: string;
- };
- /** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- } | null;
- /** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
- /** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- readonly full_description?: string;
- readonly help?: string | null;
- /** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- readonly name?: string;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity: "none" | "note" | "warning" | "error" | null;
- readonly tags?: string[] | null;
- };
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed";
- readonly tool: {
- readonly guid?: string | null;
- /** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
- /** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
- } | null;
- readonly updated_at?: string | null;
- /** Format: uri */
- readonly url: string;
- };
- /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly commit_oid: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly ref: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** code_scanning_alert fixed event */
- readonly "webhook-code-scanning-alert-fixed": {
- /** @enum {string} */
- readonly action: "fixed";
- /** @description The code scanning alert involved in the event. */
- readonly alert: {
- /**
- * Format: date-time
- * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- readonly dismissed_at: string | null;
- /** User */
- readonly dismissed_by: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * @description The reason for dismissing or closing the alert.
- * @enum {string|null}
- */
- readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
- /**
- * Format: uri
- * @description The GitHub URL of the alert resource.
- */
- readonly html_url: string;
- /** Format: uri */
- readonly instances_url?: string;
- /** Alert Instance */
- readonly most_recent_instance?: {
- /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
- /** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: string[];
- readonly commit_sha?: string;
- /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
- };
- readonly message?: {
- readonly text?: string;
- };
- /** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- } | null;
- /** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
- /** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- readonly full_description?: string;
- readonly help?: string | null;
- /** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- readonly name?: string;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity: "none" | "note" | "warning" | "error" | null;
- readonly tags?: string[] | null;
- };
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "fixed";
- readonly tool: {
- readonly guid?: string | null;
- /** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
- /** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
- };
- /** Format: uri */
- readonly url: string;
- };
- /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly commit_oid: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly ref: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** code_scanning_alert reopened event */
- readonly "webhook-code-scanning-alert-reopened": {
- /** @enum {string} */
- readonly action: "reopened";
- /** @description The code scanning alert involved in the event. */
- readonly alert: {
- /**
- * Format: date-time
- * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
- */
- readonly created_at: string;
- /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly dismissed_at: string | null;
- readonly dismissed_by: Record;
- /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
- readonly dismissed_reason: string | null;
- /**
- * Format: uri
- * @description The GitHub URL of the alert resource.
- */
- readonly html_url: string;
- /** Alert Instance */
- readonly most_recent_instance?: {
- /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
- /** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: string[];
- readonly commit_sha?: string;
- /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
- };
- readonly message?: {
- readonly text?: string;
- };
- /** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- } | null;
- /** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
- /** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- readonly full_description?: string;
- readonly help?: string | null;
- /** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- readonly name?: string;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity: "none" | "note" | "warning" | "error" | null;
- readonly tags?: string[] | null;
- };
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- readonly tool: {
- readonly guid?: string | null;
- /** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
- /** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
- };
- /** Format: uri */
- readonly url: string;
- } | null;
- /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly commit_oid: string | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly ref: string | null;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** code_scanning_alert reopened_by_user event */
- readonly "webhook-code-scanning-alert-reopened-by-user": {
- /** @enum {string} */
- readonly action: "reopened_by_user";
- /** @description The code scanning alert involved in the event. */
- readonly alert: {
- /**
- * Format: date-time
- * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
- */
- readonly created_at: string;
- /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly dismissed_at: unknown;
- readonly dismissed_by: unknown;
- /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
- readonly dismissed_reason: unknown;
- /**
- * Format: uri
- * @description The GitHub URL of the alert resource.
- */
- readonly html_url: string;
- /** Alert Instance */
- readonly most_recent_instance?: {
- /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
- /** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: string[];
- readonly commit_sha?: string;
- /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
- };
- readonly message?: {
- readonly text?: string;
- };
- /** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "dismissed" | "fixed";
- } | null;
- /** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
- /** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- /** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- readonly severity: "none" | "note" | "warning" | "error" | null;
- };
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- readonly state: "open" | "fixed";
- readonly tool: {
- /** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
- /** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
- };
- /** Format: uri */
- readonly url: string;
- };
- /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly commit_oid: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly ref: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** commit_comment created event */
- readonly "webhook-commit-comment-created": {
- /**
- * @description The action performed. Can be `created`.
- * @enum {string}
- */
- readonly action: "created";
- /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description The text of the comment. */
- readonly body: string;
- /** @description The SHA of the commit to which the comment applies. */
- readonly commit_id: string;
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- /** @description The ID of the commit comment. */
- readonly id: number;
- /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly line: number | null;
- /** @description The node ID of the commit comment. */
- readonly node_id: string;
- /** @description The relative path of the file to which the comment applies. */
- readonly path: string | null;
- /** @description The line index in the diff to which the comment applies. */
- readonly position: number | null;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** create event */
- readonly "webhook-create": {
- /** @description The repository's current description. */
- readonly description: string | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The name of the repository's default branch (usually `main`). */
- readonly master_branch: string;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The pusher type for the event. Can be either `user` or a deploy key. */
- readonly pusher_type: string;
- /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */
- readonly ref: string;
- /**
- * @description The type of Git ref object created in the repository.
- * @enum {string}
- */
- readonly ref_type: "tag" | "branch";
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** custom property created event */
- readonly "webhook-custom-property-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly definition: components["schemas"]["org-custom-property"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** custom property deleted event */
- readonly "webhook-custom-property-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly definition: {
- /** @description The name of the property that was deleted. */
- readonly property_name: string;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** custom property updated event */
- readonly "webhook-custom-property-updated": {
- /** @enum {string} */
- readonly action: "updated";
- readonly definition: components["schemas"]["org-custom-property"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** Custom property values updated event */
- readonly "webhook-custom-property-values-updated": {
- /** @enum {string} */
- readonly action: "updated";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- /** @description The new custom property values for the repository. */
- readonly new_property_values: components["schemas"]["custom-property-value"][];
- /** @description The old custom property values for the repository. */
- readonly old_property_values: components["schemas"]["custom-property-value"][];
- };
- /** delete event */
- readonly "webhook-delete": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The pusher type for the event. Can be either `user` or a deploy key. */
- readonly pusher_type: string;
- /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */
- readonly ref: string;
- /**
- * @description The type of Git ref object deleted in the repository.
- * @enum {string}
- */
- readonly ref_type: "tag" | "branch";
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert auto-dismissed event */
- readonly "webhook-dependabot-alert-auto-dismissed": {
- /** @enum {string} */
- readonly action: "auto_dismissed";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert auto-reopened event */
- readonly "webhook-dependabot-alert-auto-reopened": {
- /** @enum {string} */
- readonly action: "auto_reopened";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert created event */
- readonly "webhook-dependabot-alert-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert dismissed event */
- readonly "webhook-dependabot-alert-dismissed": {
- /** @enum {string} */
- readonly action: "dismissed";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert fixed event */
- readonly "webhook-dependabot-alert-fixed": {
- /** @enum {string} */
- readonly action: "fixed";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert reintroduced event */
- readonly "webhook-dependabot-alert-reintroduced": {
- /** @enum {string} */
- readonly action: "reintroduced";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Dependabot alert reopened event */
- readonly "webhook-dependabot-alert-reopened": {
- /** @enum {string} */
- readonly action: "reopened";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** deploy_key created event */
- readonly "webhook-deploy-key-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */
- readonly key: {
- readonly added_by?: string | null;
- readonly created_at: string;
- readonly id: number;
- readonly key: string;
- readonly last_used?: string | null;
- readonly read_only: boolean;
- readonly title: string;
- /** Format: uri */
- readonly url: string;
- readonly verified: boolean;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** deploy_key deleted event */
- readonly "webhook-deploy-key-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */
- readonly key: {
- readonly added_by?: string | null;
- readonly created_at: string;
- readonly id: number;
- readonly key: string;
- readonly last_used?: string | null;
- readonly read_only: boolean;
- readonly title: string;
- /** Format: uri */
- readonly url: string;
- readonly verified: boolean;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** deployment created event */
- readonly "webhook-deployment-created": {
- /** @enum {string} */
- readonly action: "created";
- /**
- * Deployment
- * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).
- */
- readonly deployment: {
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- readonly environment: string;
- readonly id: number;
- readonly node_id: string;
- readonly original_environment: string;
- readonly payload: Record | string;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly production_environment?: boolean;
- readonly ref: string;
- /** Format: uri */
- readonly repository_url: string;
- readonly sha: string;
- /** Format: uri */
- readonly statuses_url: string;
- readonly task: string;
- readonly transient_environment?: boolean;
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- /** Workflow */
- readonly workflow: {
- /** Format: uri */
- readonly badge_url: string;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly state: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- /** Deployment Workflow Run */
- readonly workflow_run: {
- /** User */
- readonly actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
- /** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
- /** Format: date-time */
- readonly created_at: string;
- readonly display_title: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: unknown;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: unknown;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: unknown;
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly referenced_workflows?: {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
- }[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: unknown;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
- /** Format: date-time */
- readonly run_started_at: string;
- /** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
- /** User */
- readonly triggering_actor?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
- } | null;
- };
- /** deployment protection rule requested event */
- readonly "webhook-deployment-protection-rule-requested": {
- /** @enum {string} */
- readonly action?: "requested";
- /** @description The name of the environment that has the deployment protection rule. */
- readonly environment?: string;
- /** @description The event that triggered the deployment protection rule. */
- readonly event?: string;
- /**
- * Format: uri
- * @description The URL to review the deployment protection rule.
- */
- readonly deployment_callback_url?: string;
- readonly deployment?: components["schemas"]["deployment"];
- readonly pull_requests?: components["schemas"]["pull-request"][];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- readonly "webhook-deployment-review-approved": {
- /** @enum {string} */
- readonly action: "approved";
- readonly approver?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly comment?: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly reviewers?: {
- /** User */
- readonly reviewer?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @enum {string} */
- readonly type?: "User";
- }[];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly since: string;
- readonly workflow_job_run?: {
- readonly conclusion: unknown;
- readonly created_at: string;
- readonly environment: string;
- readonly html_url: string;
- readonly id: number;
- readonly name: unknown;
- readonly status: string;
- readonly updated_at: string;
- };
- readonly workflow_job_runs?: {
- readonly conclusion?: unknown;
- readonly created_at?: string;
- readonly environment?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly name?: string | null;
- readonly status?: string;
- readonly updated_at?: string;
- }[];
- /** Deployment Workflow Run */
- readonly workflow_run: {
- /** User */
- readonly actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
- /** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
- /** Format: date-time */
- readonly created_at: string;
- readonly display_title: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: Record;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: string | null;
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly referenced_workflows?: {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
- }[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
- /** Format: date-time */
- readonly run_started_at: string;
- /** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
- /** User */
- readonly triggering_actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
- } | null;
- };
- readonly "webhook-deployment-review-rejected": {
- /** @enum {string} */
- readonly action: "rejected";
- readonly approver?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly comment?: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly reviewers?: {
- /** User */
- readonly reviewer?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @enum {string} */
- readonly type?: "User";
- }[];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly since: string;
- readonly workflow_job_run?: {
- readonly conclusion: unknown;
- readonly created_at: string;
- readonly environment: string;
- readonly html_url: string;
- readonly id: number;
- readonly name: unknown;
- readonly status: string;
- readonly updated_at: string;
- };
- readonly workflow_job_runs?: {
- readonly conclusion?: string | null;
- readonly created_at?: string;
- readonly environment?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly name?: string | null;
- readonly status?: string;
- readonly updated_at?: string;
- }[];
- /** Deployment Workflow Run */
- readonly workflow_run: {
- /** User */
- readonly actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
- /** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
- /** Format: date-time */
- readonly created_at: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: Record;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: string | null;
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly referenced_workflows?: {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
- }[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
- /** Format: date-time */
- readonly run_started_at: string;
- /** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting";
- /** User */
- readonly triggering_actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
- readonly display_title: string;
- } | null;
- };
- readonly "webhook-deployment-review-requested": {
- /** @enum {string} */
- readonly action: "requested";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly environment: string;
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- /** User */
- readonly requestor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly reviewers: {
- /** User */
- readonly reviewer?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login?: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @enum {string} */
- readonly type?: "User" | "Team";
- }[];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- readonly since: string;
- readonly workflow_job_run: {
- readonly conclusion: unknown;
- readonly created_at: string;
- readonly environment: string;
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly status: string;
- readonly updated_at: string;
- };
- /** Deployment Workflow Run */
- readonly workflow_run: {
- /** User */
- readonly actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
- /** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
- /** Format: date-time */
- readonly created_at: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: Record;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: string | null;
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly referenced_workflows?: {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
- }[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
- /** Format: date-time */
- readonly run_started_at: string;
- /** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
- /** User */
- readonly triggering_actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
- readonly display_title: string;
- } | null;
- };
- /** deployment_status created event */
- readonly "webhook-deployment-status-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly check_run?: {
- /** Format: date-time */
- readonly completed_at: string | null;
- /**
- * @description The result of the completed check run. This value will be `null` until the check run has completed.
- * @enum {string|null}
- */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null;
- /** Format: uri */
- readonly details_url: string;
- readonly external_id: string;
- /** @description The SHA of the commit that is being checked. */
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- /** @description The id of the check. */
- readonly id: number;
- /** @description The name of the check run. */
- readonly name: string;
- readonly node_id: string;
- /** Format: date-time */
- readonly started_at: string;
- /**
- * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`.
- * @enum {string}
- */
- readonly status: "queued" | "in_progress" | "completed" | "waiting" | "pending";
- /** Format: uri */
- readonly url: string;
- } | null;
- /**
- * Deployment
- * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).
- */
- readonly deployment: {
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- readonly environment: string;
- readonly id: number;
- readonly node_id: string;
- readonly original_environment: string;
- readonly payload: (string | Record) | null;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly production_environment?: boolean;
- readonly ref: string;
- /** Format: uri */
- readonly repository_url: string;
- readonly sha: string;
- /** Format: uri */
- readonly statuses_url: string;
- readonly task: string;
- readonly transient_environment?: boolean;
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */
- readonly deployment_status: {
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: uri */
- readonly deployment_url: string;
- /** @description The optional human-readable description added to the status. */
- readonly description: string;
- readonly environment: string;
- /** Format: uri */
- readonly environment_url?: string;
- readonly id: number;
- /** Format: uri */
- readonly log_url?: string;
- readonly node_id: string;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- /** Format: uri */
- readonly repository_url: string;
- /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */
- readonly state: string;
- /** @description The optional link added to the status. */
- readonly target_url: string;
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- /** Workflow */
- readonly workflow?: {
- /** Format: uri */
- readonly badge_url: string;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly state: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- /** Deployment Workflow Run */
- readonly workflow_run?: {
- /** User */
- readonly actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
- /** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure";
- /** Format: date-time */
- readonly created_at: string;
- readonly display_title: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: unknown;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: unknown;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: unknown;
- readonly pull_requests: {
- readonly base: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly head: {
- readonly ref: string;
- /** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly sha: string;
- };
- readonly id: number;
- readonly number: number;
- /** Format: uri */
- readonly url: string;
- }[];
- readonly referenced_workflows?: {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
- }[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: unknown;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
- /** Format: date-time */
- readonly run_started_at: string;
- /** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
- /** User */
- readonly triggering_actor: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
- } | null;
- };
- /** discussion answered event */
- readonly "webhook-discussion-answered": {
- /** @enum {string} */
- readonly action: "answered";
- readonly answer: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string;
- readonly child_comment_count: number;
- /** Format: date-time */
- readonly created_at: string;
- readonly discussion_id: number;
- readonly html_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly parent_id: unknown;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion category changed event */
- readonly "webhook-discussion-category-changed": {
- /** @enum {string} */
- readonly action: "category_changed";
- readonly changes: {
- readonly category: {
- readonly from: {
- /** Format: date-time */
- readonly created_at: string;
- readonly description: string;
- readonly emoji: string;
- readonly id: number;
- readonly is_answerable: boolean;
- readonly name: string;
- readonly node_id?: string;
- readonly repository_id: number;
- readonly slug: string;
- readonly updated_at: string;
- };
- };
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion closed event */
- readonly "webhook-discussion-closed": {
- /** @enum {string} */
- readonly action: "closed";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion_comment created event */
- readonly "webhook-discussion-comment-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string;
- readonly child_comment_count: number;
- readonly created_at: string;
- readonly discussion_id: number;
- readonly html_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly parent_id: number | null;
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- readonly updated_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion_comment deleted event */
- readonly "webhook-discussion-comment-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string;
- readonly child_comment_count: number;
- readonly created_at: string;
- readonly discussion_id: number;
- readonly html_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly parent_id: number | null;
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- readonly updated_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion_comment edited event */
- readonly "webhook-discussion-comment-edited": {
- /** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly body: {
- readonly from: string;
- };
- };
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string;
- readonly child_comment_count: number;
- readonly created_at: string;
- readonly discussion_id: number;
- readonly html_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly parent_id: number | null;
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- readonly updated_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion created event */
- readonly "webhook-discussion-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly discussion: {
- readonly active_lock_reason: string | null;
- readonly answer_chosen_at: string | null;
- /** User */
- readonly answer_chosen_by: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly answer_html_url: string | null;
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string | null;
- readonly category: {
- /** Format: date-time */
- readonly created_at: string;
- readonly description: string;
- readonly emoji: string;
- readonly id: number;
- readonly is_answerable: boolean;
- readonly name: string;
- readonly node_id?: string;
- readonly repository_id: number;
- readonly slug: string;
- readonly updated_at: string;
- };
- readonly comments: number;
- /** Format: date-time */
- readonly created_at: string;
- readonly html_url: string;
- readonly id: number;
- readonly locked: boolean;
- readonly node_id: string;
- readonly number: number;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- /** @enum {string} */
- readonly state: "open" | "locked" | "converting" | "transferring";
- readonly timeline_url?: string;
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: unknown;
- readonly answer_chosen_at: unknown;
- readonly answer_chosen_by: unknown;
- readonly answer_html_url: string | null;
- readonly author_association?: string;
- readonly body?: string | null;
- readonly category?: {
- readonly created_at?: string;
- readonly description?: string;
- readonly emoji?: string;
- readonly id?: number;
- readonly is_answerable?: boolean;
- readonly name?: string;
- readonly node_id?: string;
- readonly repository_id?: number;
- readonly slug?: string;
- readonly updated_at?: string;
- };
- readonly comments?: number;
- readonly created_at?: string;
- readonly html_url?: string;
- readonly id?: number;
- /** @enum {boolean} */
- readonly locked: false;
- readonly node_id?: string;
- readonly number?: number;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- /** @enum {string} */
- readonly state: "open" | "converting" | "transferring";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion deleted event */
- readonly "webhook-discussion-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion edited event */
- readonly "webhook-discussion-edited": {
- /** @enum {string} */
- readonly action: "edited";
- readonly changes?: {
- readonly body?: {
- readonly from: string;
- };
- readonly title?: {
- readonly from: string;
- };
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion labeled event */
- readonly "webhook-discussion-labeled": {
- /** @enum {string} */
- readonly action: "labeled";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** Label */
- readonly label: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion locked event */
- readonly "webhook-discussion-locked": {
- /** @enum {string} */
- readonly action: "locked";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion pinned event */
- readonly "webhook-discussion-pinned": {
- /** @enum {string} */
- readonly action: "pinned";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion reopened event */
- readonly "webhook-discussion-reopened": {
- /** @enum {string} */
- readonly action: "reopened";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion transferred event */
- readonly "webhook-discussion-transferred": {
- /** @enum {string} */
- readonly action: "transferred";
- readonly changes: {
- readonly new_discussion: components["schemas"]["discussion"];
- readonly new_repository: components["schemas"]["repository-webhooks"];
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion unanswered event */
- readonly "webhook-discussion-unanswered": {
- /** @enum {string} */
- readonly action: "unanswered";
- readonly discussion: components["schemas"]["discussion"];
- readonly old_answer: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string;
- readonly child_comment_count: number;
- /** Format: date-time */
- readonly created_at: string;
- readonly discussion_id: number;
- readonly html_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly parent_id: unknown;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion unlabeled event */
- readonly "webhook-discussion-unlabeled": {
- /** @enum {string} */
- readonly action: "unlabeled";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** Label */
- readonly label: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion unlocked event */
- readonly "webhook-discussion-unlocked": {
- /** @enum {string} */
- readonly action: "unlocked";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** discussion unpinned event */
- readonly "webhook-discussion-unpinned": {
- /** @enum {string} */
- readonly action: "unpinned";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /**
- * fork event
- * @description A user forks a repository.
- */
- readonly "webhook-fork": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */
- readonly forkee: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
- /** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
- /** Format: uri-template */
- readonly assignees_url: string;
- /** Format: uri-template */
- readonly blobs_url: string;
- /** Format: uri-template */
- readonly branches_url: string;
- /** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
- /** Format: uri-template */
- readonly commits_url: string;
- /** Format: uri-template */
- readonly compare_url: string;
- /** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
- };
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
- /** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
- /** Format: uri */
- readonly downloads_url: string;
- /** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
- /** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
- /** Format: uri-template */
- readonly git_tags_url: string;
- /** Format: uri */
- readonly git_url: string;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
- readonly homepage: string | null;
- /** Format: uri */
- readonly hooks_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
- /** Format: uri-template */
- readonly issues_url: string;
- /** Format: uri-template */
- readonly keys_url: string;
- /** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
- /** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
- /** Format: uri */
- readonly merges_url: string;
- /** Format: uri-template */
- readonly milestones_url: string;
- /** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- };
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
- /** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
- /** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
- /** Format: uri */
- readonly subscription_url: string;
- /** Format: uri */
- readonly svn_url: string;
- /** Format: uri */
- readonly tags_url: string;
- /** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
- /** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
- } & {
- readonly allow_forking?: boolean;
- readonly archive_url?: string;
- readonly archived?: boolean;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly clone_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly created_at?: string;
- readonly default_branch?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly disabled?: boolean;
- readonly downloads_url?: string;
- readonly events_url?: string;
- /** @enum {boolean} */
- readonly fork?: true;
- readonly forks?: number;
- readonly forks_count?: number;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly git_url?: string;
- readonly has_downloads?: boolean;
- readonly has_issues?: boolean;
- readonly has_pages?: boolean;
- readonly has_projects?: boolean;
- readonly has_wiki?: boolean;
- readonly homepage?: string | null;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly is_template?: boolean;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly language?: unknown;
- readonly languages_url?: string;
- readonly license?: Record;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly mirror_url?: unknown;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly open_issues?: number;
- readonly open_issues_count?: number;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly public?: boolean;
- readonly pulls_url?: string;
- readonly pushed_at?: string;
- readonly releases_url?: string;
- readonly size?: number;
- readonly ssh_url?: string;
- readonly stargazers_count?: number;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly svn_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly topics?: unknown[];
- readonly trees_url?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly visibility?: string;
- readonly watchers?: number;
- readonly watchers_count?: number;
- };
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** github_app_authorization revoked event */
- readonly "webhook-github-app-authorization-revoked": {
- /** @enum {string} */
- readonly action: "revoked";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** gollum event */
- readonly "webhook-gollum": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description The pages that were updated. */
- readonly pages: {
- /**
- * @description The action that was performed on the page. Can be `created` or `edited`.
- * @enum {string}
- */
- readonly action: "created" | "edited";
- /**
- * Format: uri
- * @description Points to the HTML wiki page.
- */
- readonly html_url: string;
- /** @description The name of the page. */
- readonly page_name: string;
- /** @description The latest commit SHA of the page. */
- readonly sha: string;
- readonly summary: string | null;
- /** @description The current page title. */
- readonly title: string;
- }[];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** installation created event */
- readonly "webhook-installation-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects that the installation can access. */
- readonly repositories?: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- /** User */
- readonly requester?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** installation deleted event */
- readonly "webhook-installation-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects that the installation can access. */
- readonly repositories?: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly requester?: unknown;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** installation new_permissions_accepted event */
- readonly "webhook-installation-new-permissions-accepted": {
- /** @enum {string} */
- readonly action: "new_permissions_accepted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects that the installation can access. */
- readonly repositories?: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly requester?: unknown;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** installation_repositories added event */
- readonly "webhook-installation-repositories-added": {
- /** @enum {string} */
- readonly action: "added";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects, which were added to the installation. */
- readonly repositories_added: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- /** @description An array of repository objects, which were removed from the installation. */
- readonly repositories_removed: {
- readonly full_name?: string;
- /** @description Unique identifier of the repository */
- readonly id?: number;
- /** @description The name of the repository. */
- readonly name?: string;
- readonly node_id?: string;
- /** @description Whether the repository is private or public. */
- readonly private?: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- /**
- * @description Describe whether all repositories have been selected or there's a selection involved
- * @enum {string}
- */
- readonly repository_selection: "all" | "selected";
- /** User */
- readonly requester: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** installation_repositories removed event */
- readonly "webhook-installation-repositories-removed": {
- /** @enum {string} */
- readonly action: "removed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects, which were added to the installation. */
- readonly repositories_added: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- /** @description An array of repository objects, which were removed from the installation. */
- readonly repositories_removed: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- /**
- * @description Describe whether all repositories have been selected or there's a selection involved
- * @enum {string}
- */
- readonly repository_selection: "all" | "selected";
- /** User */
- readonly requester: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** installation suspend event */
- readonly "webhook-installation-suspend": {
- /** @enum {string} */
- readonly action: "suspend";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects that the installation can access. */
- readonly repositories?: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly requester?: unknown;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- readonly "webhook-installation-target-renamed": {
- readonly account: {
- readonly archived_at?: string | null;
- readonly avatar_url: string;
- readonly created_at?: string;
- readonly description?: unknown;
- readonly events_url?: string;
- readonly followers?: number;
- readonly followers_url?: string;
- readonly following?: number;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly has_organization_projects?: boolean;
- readonly has_repository_projects?: boolean;
- readonly hooks_url?: string;
- readonly html_url: string;
- readonly id: number;
- readonly is_verified?: boolean;
- readonly issues_url?: string;
- readonly login?: string;
- readonly members_url?: string;
- readonly name?: string;
- readonly node_id: string;
- readonly organizations_url?: string;
- readonly public_gists?: number;
- readonly public_members_url?: string;
- readonly public_repos?: number;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly slug?: string;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly website_url?: unknown;
- };
- /** @enum {string} */
- readonly action: "renamed";
- readonly changes: {
- readonly login?: {
- readonly from: string;
- };
- readonly slug?: {
- readonly from: string;
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- readonly target_type: string;
- };
- /** installation unsuspend event */
- readonly "webhook-installation-unsuspend": {
- /** @enum {string} */
- readonly action: "unsuspend";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description An array of repository objects that the installation can access. */
- readonly repositories?: {
- readonly full_name: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- }[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly requester?: unknown;
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issue_comment created event */
- readonly "webhook-issue-comment-created": {
- /** @enum {string} */
- readonly action: "created";
- /**
- * issue comment
- * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
- */
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue comment */
- readonly body: string;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- /**
- * Format: int64
- * @description Unique identifier of the issue comment
- */
- readonly id: number;
- /** Format: uri */
- readonly issue_url: string;
- readonly node_id: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue comment
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: string | null;
- /** User */
- readonly assignee: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- readonly labels_url?: string;
- readonly locked: boolean;
- readonly milestone?: Record;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state: "open" | "closed";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issue_comment deleted event */
- readonly "webhook-issue-comment-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- /**
- * issue comment
- * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
- */
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue comment */
- readonly body: string;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- /**
- * Format: int64
- * @description Unique identifier of the issue comment
- */
- readonly id: number;
- /** Format: uri */
- readonly issue_url: string;
- readonly node_id: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue comment
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: string | null;
- /** User */
- readonly assignee: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- readonly labels_url?: string;
- readonly locked: boolean;
- readonly milestone?: Record;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state: "open" | "closed";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issue_comment edited event */
- readonly "webhook-issue-comment-edited": {
- /** @enum {string} */
- readonly action: "edited";
- /** @description The changes to the comment. */
- readonly changes: {
- readonly body?: {
- /** @description The previous version of the body. */
- readonly from: string;
- };
- };
- /**
- * issue comment
- * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
- */
- readonly comment: {
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue comment */
- readonly body: string;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: uri */
- readonly html_url: string;
- /**
- * Format: int64
- * @description Unique identifier of the issue comment
- */
- readonly id: number;
- /** Format: uri */
- readonly issue_url: string;
- readonly node_id: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue comment
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: string | null;
- /** User */
- readonly assignee: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- readonly labels_url?: string;
- readonly locked: boolean;
- readonly milestone?: Record;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state: "open" | "closed";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues assigned event */
- readonly "webhook-issues-assigned": {
- /**
- * @description The action that was performed.
- * @enum {string}
- */
- readonly action: "assigned";
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues closed event */
- readonly "webhook-issues-closed": {
- /**
- * @description The action that was performed.
- * @enum {string}
- */
- readonly action: "closed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: string | null;
- readonly assignee?: Record;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels?: Record[];
- readonly labels_url?: string;
- readonly locked?: boolean;
- readonly milestone?: Record;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- /** @enum {string} */
- readonly state: "closed" | "open";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues deleted event */
- readonly "webhook-issues-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues demilestoned event */
- readonly "webhook-issues-demilestoned": {
- /** @enum {string} */
- readonly action: "demilestoned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: string | null;
- readonly assignee?: Record;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels?: Record[];
- readonly labels_url?: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- readonly state?: string;
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
+ readonly "nullable-repository-webhooks": {
/**
- * Milestone
- * @description A collection of related issues and pull requests.
+ * @description Unique identifier of the repository
+ * @example 42
*/
- readonly milestone?: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
+ readonly id: number;
+ /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ readonly node_id: string;
+ /**
+ * @description The name of the repository.
+ * @example Team Environment
+ */
+ readonly name: string;
+ /** @example octocat/Hello-World */
+ readonly full_name: string;
+ readonly license: components["schemas"]["nullable-license-simple"];
+ readonly organization?: components["schemas"]["nullable-simple-user"];
+ readonly forks: number;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly pull: boolean;
+ readonly triage?: boolean;
+ readonly push: boolean;
+ readonly maintain?: boolean;
};
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues edited event */
- readonly "webhook-issues-edited": {
- /** @enum {string} */
- readonly action: "edited";
- /** @description The changes to the issue. */
- readonly changes: {
- readonly body?: {
- /** @description The previous version of the body. */
- readonly from: string;
- };
- readonly title?: {
- /** @description The previous version of the title. */
- readonly from: string;
- };
+ readonly owner: components["schemas"]["simple-user"];
+ /**
+ * @description Whether the repository is private or public.
+ * @default false
+ */
+ readonly private: boolean;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World
+ */
+ readonly html_url: string;
+ /** @example This your first repo! */
+ readonly description: string | null;
+ readonly fork: boolean;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World
+ */
+ readonly url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
+ readonly archive_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
+ readonly assignees_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
+ readonly blobs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
+ readonly branches_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
+ readonly collaborators_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
+ readonly comments_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
+ readonly commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
+ readonly compare_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
+ readonly contents_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/contributors
+ */
+ readonly contributors_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/deployments
+ */
+ readonly deployments_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/downloads
+ */
+ readonly downloads_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/events
+ */
+ readonly events_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/forks
+ */
+ readonly forks_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
+ readonly git_commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
+ readonly git_refs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
+ readonly git_tags_url: string;
+ /** @example git:github.com/octocat/Hello-World.git */
+ readonly git_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
+ readonly issue_comment_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
+ readonly issue_events_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
+ readonly issues_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
+ readonly keys_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
+ readonly labels_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/languages
+ */
+ readonly languages_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/merges
+ */
+ readonly merges_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
+ readonly milestones_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
+ readonly notifications_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
+ readonly pulls_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
+ readonly releases_url: string;
+ /** @example git@github.com:octocat/Hello-World.git */
+ readonly ssh_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/stargazers
+ */
+ readonly stargazers_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
+ readonly statuses_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscribers
+ */
+ readonly subscribers_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscription
+ */
+ readonly subscription_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/tags
+ */
+ readonly tags_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/teams
+ */
+ readonly teams_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
+ readonly trees_url: string;
+ /** @example https://github.com/octocat/Hello-World.git */
+ readonly clone_url: string;
+ /**
+ * Format: uri
+ * @example git:git.example.com/octocat/Hello-World
+ */
+ readonly mirror_url: string | null;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/hooks
+ */
+ readonly hooks_url: string;
+ /**
+ * Format: uri
+ * @example https://svn.github.com/octocat/Hello-World
+ */
+ readonly svn_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com
+ */
+ readonly homepage: string | null;
+ readonly language: string | null;
+ /** @example 9 */
+ readonly forks_count: number;
+ /** @example 80 */
+ readonly stargazers_count: number;
+ /** @example 80 */
+ readonly watchers_count: number;
+ /**
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @example 108
+ */
+ readonly size: number;
+ /**
+ * @description The default branch of the repository.
+ * @example master
+ */
+ readonly default_branch: string;
+ /** @example 0 */
+ readonly open_issues_count: number;
+ /**
+ * @description Whether this repository acts as a template that can be used to generate new repositories.
+ * @default false
+ * @example true
+ */
+ readonly is_template: boolean;
+ readonly topics?: string[];
+ /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
+ readonly custom_properties?: {
+ readonly [key: string]: unknown;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
/**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ * @description Whether issues are enabled.
+ * @default true
+ * @example true
*/
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
+ readonly has_issues: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ * @example true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ * @example true
+ */
+ readonly has_wiki: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ * @example true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ * @example true
+ */
+ readonly has_discussions: boolean;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
+ /** @description Returns whether or not this repository disabled. */
+ readonly disabled: boolean;
+ /**
+ * @description The repository visibility: public, private, or internal.
+ * @default public
+ */
+ readonly visibility: string;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
+ */
+ readonly pushed_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
+ */
+ readonly created_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:14:43Z
+ */
+ readonly updated_at: string | null;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ * @example true
+ */
+ readonly allow_rebase_merge: boolean;
+ readonly template_repository?: {
+ readonly id?: number;
+ readonly node_id?: string;
+ readonly name?: string;
+ readonly full_name?: string;
+ readonly owner?: {
+ readonly login?: string;
+ readonly id?: number;
+ readonly node_id?: string;
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
+ readonly html_url?: string;
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
+ readonly events_url?: string;
+ readonly received_events_url?: string;
+ readonly type?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
+ };
+ readonly private?: boolean;
+ readonly html_url?: string;
+ readonly description?: string;
+ readonly fork?: boolean;
+ readonly url?: string;
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly forks_url?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly git_url?: string;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly notifications_url?: string;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly ssh_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly clone_url?: string;
+ readonly mirror_url?: string;
+ readonly hooks_url?: string;
+ readonly svn_url?: string;
+ readonly homepage?: string;
+ readonly language?: string;
+ readonly forks_count?: number;
+ readonly stargazers_count?: number;
+ readonly watchers_count?: number;
+ readonly size?: number;
+ readonly default_branch?: string;
+ readonly open_issues_count?: number;
+ readonly is_template?: boolean;
+ readonly topics?: string[];
+ readonly has_issues?: boolean;
+ readonly has_projects?: boolean;
+ readonly has_wiki?: boolean;
+ readonly has_pages?: boolean;
+ readonly has_downloads?: boolean;
+ readonly archived?: boolean;
+ readonly disabled?: boolean;
+ readonly visibility?: string;
+ readonly pushed_at?: string;
+ readonly created_at?: string;
+ readonly updated_at?: string;
+ readonly permissions?: {
+ readonly admin?: boolean;
+ readonly maintain?: boolean;
+ readonly push?: boolean;
+ readonly triage?: boolean;
+ readonly pull?: boolean;
+ };
+ readonly allow_rebase_merge?: boolean;
+ readonly temp_clone_token?: string;
+ readonly allow_squash_merge?: boolean;
+ readonly allow_auto_merge?: boolean;
+ readonly delete_branch_on_merge?: boolean;
+ readonly allow_update_branch?: boolean;
+ readonly use_squash_pr_title_as_default?: boolean;
/**
- * AuthorAssociation
- * @description How the author is associated with the repository.
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
*/
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
- * @description State of the issue; either 'open' or 'closed'
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
- * Format: uri
- * @description URL for the issue
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
*/
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- /** Label */
- readonly label?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ readonly allow_merge_commit?: boolean;
+ readonly subscribers_count?: number;
+ readonly network_count?: number;
+ } | null;
+ readonly temp_clone_token?: string;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ * @example true
+ */
+ readonly allow_squash_merge: boolean;
+ /**
+ * @description Whether to allow Auto-merge to be used on pull requests.
+ * @default false
+ * @example false
+ */
+ readonly allow_auto_merge: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ * @example false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /**
+ * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
+ * @default false
+ * @example false
+ */
+ readonly allow_update_branch: boolean;
+ /**
+ * @deprecated
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ * @example true
+ */
+ readonly allow_merge_commit: boolean;
+ /** @description Whether to allow forking this repo */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to require contributors to sign off on web-based commits
+ * @default false
+ */
+ readonly web_commit_signoff_required: boolean;
+ readonly subscribers_count?: number;
+ readonly network_count?: number;
+ readonly open_issues: number;
+ readonly watchers: number;
+ readonly master_branch?: string;
+ /** @example "2020-07-09T00:17:42Z" */
+ readonly starred_at?: string;
+ /** @description Whether anonymous git access is enabled for this repository */
+ readonly anonymous_access_enabled?: boolean;
+ } | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly webhooks_milestone_3: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues labeled event */
- readonly "webhook-issues-labeled": {
- /** @enum {string} */
- readonly action: "labeled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
/**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ * @description The state of the milestone.
+ * @enum {string}
*/
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /**
+ * Membership
+ * @description The membership between the user and the organization. Not present when the action is `member_invited`.
+ */
+ readonly webhooks_membership: {
+ /** Format: uri */
+ readonly organization_url: string;
+ readonly role: string;
+ readonly state: string;
+ /** Format: uri */
+ readonly url: string;
+ /** User */
+ readonly user: {
/** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
/** Format: uri */
- readonly events_url: string;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
+ readonly html_url?: string;
readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
+ readonly starred_url?: string;
/** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
+ readonly url?: string;
+ } | null;
+ };
+ /**
+ * Personal Access Token Request
+ * @description Details of a Personal Access Token Request.
+ */
+ readonly "personal-access-token-request": {
+ /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */
+ readonly id: number;
+ readonly owner: components["schemas"]["simple-user"];
+ /** @description New requested permissions, categorized by type of permission. */
+ readonly permissions_added: {
+ readonly organization?: {
+ readonly [key: string]: string | undefined;
+ };
+ readonly repository?: {
+ readonly [key: string]: string | undefined;
+ };
+ readonly other?: {
+ readonly [key: string]: string | undefined;
+ };
};
- /** Label */
- readonly label?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
+ /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */
+ readonly permissions_upgraded: {
+ readonly organization?: {
+ readonly [key: string]: string | undefined;
+ };
+ readonly repository?: {
+ readonly [key: string]: string | undefined;
+ };
+ readonly other?: {
+ readonly [key: string]: string | undefined;
+ };
+ };
+ /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */
+ readonly permissions_result: {
+ readonly organization?: {
+ readonly [key: string]: string | undefined;
+ };
+ readonly repository?: {
+ readonly [key: string]: string | undefined;
+ };
+ readonly other?: {
+ readonly [key: string]: string | undefined;
+ };
+ };
+ /**
+ * @description Type of repository selection requested.
+ * @enum {string}
+ */
+ readonly repository_selection: "none" | "all" | "subset";
+ /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */
+ readonly repository_count: number | null;
+ /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */
+ readonly repositories: {
+ readonly full_name: string;
+ /** @description Unique identifier of the repository */
readonly id: number;
- /** @description The name of the label. */
+ /** @description The name of the repository. */
readonly name: string;
readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ }[] | null;
+ /** @description Date and time when the request for access was created. */
+ readonly created_at: string;
+ /** @description Whether the associated fine-grained personal access token has expired. */
+ readonly token_expired: boolean;
+ /** @description Date and time when the associated fine-grained personal access token expires. */
+ readonly token_expires_at: string | null;
+ /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */
+ readonly token_last_used_at: string | null;
};
- /** issues locked event */
- readonly "webhook-issues-locked": {
- /** @enum {string} */
- readonly action: "locked";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ /** Project Card */
+ readonly webhooks_project_card: {
+ readonly after_id?: number | null;
+ /** @description Whether or not the card is archived */
+ readonly archived: boolean;
+ readonly column_id: number;
+ /** Format: uri */
+ readonly column_url: string;
+ /** Format: uri */
+ readonly content_url?: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
/** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
/** Format: uri */
- readonly events_url: string;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
+ readonly html_url?: string;
readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The project card's ID */
+ readonly id: number;
+ readonly node_id: string;
+ readonly note: string | null;
+ /** Format: uri */
+ readonly project_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Project */
+ readonly webhooks_project: {
+ /** @description Body of the project */
+ readonly body: string | null;
+ /** Format: uri */
+ readonly columns_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
/** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
+ readonly url?: string;
+ } | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** @description Name of the project */
+ readonly name: string;
+ readonly node_id: string;
+ readonly number: number;
+ /** Format: uri */
+ readonly owner_url: string;
+ /**
+ * @description State of the project; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** Project Column */
+ readonly webhooks_project_column: {
+ readonly after_id?: number | null;
+ /** Format: uri */
+ readonly cards_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** @description The unique identifier of the project column */
+ readonly id: number;
+ /** @description Name of the project column */
+ readonly name: string;
+ readonly node_id: string;
+ /** Format: uri */
+ readonly project_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /**
+ * Projects v2 Project
+ * @description A projects v2 project
+ */
+ readonly "projects-v2": {
+ readonly id: number;
+ readonly node_id: string;
+ readonly owner: components["schemas"]["simple-user"];
+ readonly creator: components["schemas"]["simple-user"];
+ readonly title: string;
+ readonly description: string | null;
+ readonly public: boolean;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly closed_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly updated_at: string;
+ readonly number: number;
+ readonly short_description: string | null;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly deleted_at: string | null;
+ readonly deleted_by: components["schemas"]["nullable-simple-user"];
+ };
+ readonly webhooks_project_changes: {
+ readonly archived_at?: {
/** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ readonly from?: string | null;
+ /** Format: date-time */
+ readonly to?: string | null;
+ };
+ };
+ /**
+ * Projects v2 Item Content Type
+ * @description The type of content tracked in a project item
+ * @enum {string}
+ */
+ readonly "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue";
+ /**
+ * Projects v2 Item
+ * @description An item belonging to a project
+ */
+ readonly "projects-v2-item": {
+ readonly id: number;
+ readonly node_id?: string;
+ readonly project_node_id?: string;
+ readonly content_node_id: string;
+ readonly content_type: components["schemas"]["projects-v2-item-content-type"];
+ readonly creator?: components["schemas"]["simple-user"];
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly updated_at: string;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ readonly archived_at: string | null;
+ };
+ /** @description The pull request number. */
+ readonly webhooks_number: number;
+ readonly "pull-request-webhook": components["schemas"]["pull-request"] & {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow updating the pull request's branch. */
+ readonly allow_update_branch?: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged.
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /**
+ * @description The default value for a merge commit message.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name").
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a squash merge commit message:
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
+ };
+ /** Pull Request */
+ readonly webhooks_pull_request_5: {
+ readonly _links: {
+ /** Link */
+ readonly comments: {
/** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
+ readonly href: string;
+ };
+ /** Link */
+ readonly commits: {
/** Format: uri-template */
- readonly following_url?: string;
+ readonly href: string;
+ };
+ /** Link */
+ readonly html: {
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ readonly href: string;
+ };
+ /** Link */
+ readonly issue: {
/** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly assignee?: Record;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comment: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly review_comments: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly self: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ /** Link */
+ readonly statuses: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ };
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly additions?: number;
+ /** User */
+ readonly assignee: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
readonly html_url?: string;
- readonly id?: number;
- readonly labels?: Record[];
- readonly labels_url?: string;
- /** @enum {boolean} */
- readonly locked: true;
- readonly milestone?: Record;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- readonly state?: string;
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues milestoned event */
- readonly "webhook-issues-milestoned": {
- /** @enum {string} */
- readonly action: "milestoned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ } | null;
+ readonly assignees: ({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ readonly auto_merge: {
+ /** @description Commit message for the merge commit. */
+ readonly commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ readonly commit_title: string | null;
/** User */
- readonly assignee?: {
+ readonly enabled_by: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -43769,174 +35470,189 @@ export interface components {
/** Format: uri */
readonly url?: string;
} | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ readonly merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ readonly base: {
+ readonly label: string;
+ readonly ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ readonly repo: {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow private forks */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ readonly allow_rebase_merge: boolean;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ readonly allow_squash_merge: boolean;
+ readonly allow_update_branch?: boolean;
/** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
+ readonly archive_url: string;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
/** Format: uri-template */
- readonly following_url?: string;
+ readonly assignees_url: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ readonly blobs_url: string;
+ /** Format: uri-template */
+ readonly branches_url: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ readonly clone_url: string;
+ /** Format: uri-template */
+ readonly collaborators_url: string;
+ /** Format: uri-template */
+ readonly comments_url: string;
+ /** Format: uri-template */
+ readonly commits_url: string;
+ /** Format: uri-template */
+ readonly compare_url: string;
+ /** Format: uri-template */
+ readonly contents_url: string;
/** Format: uri */
- readonly organizations_url?: string;
+ readonly contributors_url: string;
+ readonly created_at: number | string;
+ /** @description The default branch of the repository. */
+ readonly default_branch: string;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
/** Format: uri */
- readonly received_events_url?: string;
+ readonly deployments_url: string;
+ readonly description: string | null;
+ /** @description Returns whether or not this repository is disabled. */
+ readonly disabled?: boolean;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
+ readonly downloads_url: string;
/** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly events_url: string;
+ readonly fork: boolean;
+ readonly forks: number;
+ readonly forks_count: number;
/** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ readonly forks_url: string;
+ readonly full_name: string;
+ /** Format: uri-template */
+ readonly git_commits_url: string;
+ /** Format: uri-template */
+ readonly git_refs_url: string;
+ /** Format: uri-template */
+ readonly git_tags_url: string;
+ /** Format: uri */
+ readonly git_url: string;
/**
- * Format: uri
- * @description URL for the label
+ * @description Whether downloads are enabled.
+ * @default true
*/
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ readonly has_issues: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ readonly has_wiki: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ readonly has_discussions: boolean;
+ readonly homepage: string | null;
+ /** Format: uri */
+ readonly hooks_url: string;
/** Format: uri */
readonly html_url: string;
+ /** @description Unique identifier of the repository */
readonly id: number;
- /** Format: uri */
+ readonly is_template?: boolean;
+ /** Format: uri-template */
+ readonly issue_comment_url: string;
+ /** Format: uri-template */
+ readonly issue_events_url: string;
+ /** Format: uri-template */
+ readonly issues_url: string;
+ /** Format: uri-template */
+ readonly keys_url: string;
+ /** Format: uri-template */
readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ readonly language: string | null;
+ /** Format: uri */
+ readonly languages_url: string;
+ /** License */
+ readonly license: {
+ readonly key: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly spdx_id: string;
+ /** Format: uri */
+ readonly url: string | null;
+ } | null;
+ readonly master_branch?: string;
/**
- * @description The state of the milestone.
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[];
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly external_url: string | null;
+ readonly merges_url: string;
+ /** Format: uri-template */
+ readonly milestones_url: string;
/** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
+ readonly mirror_url: string | null;
+ /** @description The name of the repository. */
readonly name: string;
readonly node_id: string;
+ /** Format: uri-template */
+ readonly notifications_url: string;
+ readonly open_issues: number;
+ readonly open_issues_count: number;
+ readonly organization?: string;
/** User */
readonly owner: {
/** Format: uri */
@@ -43974,129 +35690,77 @@ export interface components {
/** Format: uri */
readonly url?: string;
} | null;
- /** @description The set of permissions for the GitHub app */
readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly pull: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
};
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ readonly public?: boolean;
+ /** Format: uri-template */
+ readonly pulls_url: string;
+ readonly pushed_at: (number | string) | null;
+ /** Format: uri-template */
+ readonly releases_url: string;
+ readonly role_name?: string | null;
+ readonly size: number;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly ssh_url: string;
+ readonly stargazers?: number;
+ readonly stargazers_count: number;
/** Format: uri */
- readonly diff_url?: string;
+ readonly stargazers_url: string;
+ /** Format: uri-template */
+ readonly statuses_url: string;
/** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
+ readonly subscribers_url: string;
/** Format: uri */
- readonly patch_url?: string;
+ readonly subscription_url: string;
/** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
+ readonly svn_url: string;
+ /** Format: uri */
+ readonly tags_url: string;
+ /** Format: uri */
+ readonly teams_url: string;
+ readonly topics: string[];
+ /** Format: uri-template */
+ readonly trees_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
/** Format: uri */
readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
+ /** @enum {string} */
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
};
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
+ readonly sha: string;
/** User */
readonly user: {
/** Format: uri */
@@ -44104,64 +35768,233 @@ export interface components {
readonly deleted?: boolean;
readonly email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ readonly body: string | null;
+ readonly changed_files?: number;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments?: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ readonly commits?: number;
+ /** Format: uri */
+ readonly commits_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly deletions?: number;
+ /** Format: uri */
+ readonly diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ readonly draft: boolean;
+ readonly head: {
+ readonly label: string;
+ readonly ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ readonly repo: {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow private forks */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ readonly allow_rebase_merge: boolean;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ readonly allow_squash_merge: boolean;
+ readonly allow_update_branch?: boolean;
+ /** Format: uri-template */
+ readonly archive_url: string;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
+ /** Format: uri-template */
+ readonly assignees_url: string;
+ /** Format: uri-template */
+ readonly blobs_url: string;
+ /** Format: uri-template */
+ readonly branches_url: string;
+ /** Format: uri */
+ readonly clone_url: string;
+ /** Format: uri-template */
+ readonly collaborators_url: string;
+ /** Format: uri-template */
+ readonly comments_url: string;
+ /** Format: uri-template */
+ readonly commits_url: string;
+ /** Format: uri-template */
+ readonly compare_url: string;
+ /** Format: uri-template */
+ readonly contents_url: string;
+ /** Format: uri */
+ readonly contributors_url: string;
+ readonly created_at: number | string;
+ /** @description The default branch of the repository. */
+ readonly default_branch: string;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /** Format: uri */
+ readonly deployments_url: string;
+ readonly description: string | null;
+ /** @description Returns whether or not this repository is disabled. */
+ readonly disabled?: boolean;
+ /** Format: uri */
+ readonly downloads_url: string;
+ /** Format: uri */
+ readonly events_url: string;
+ readonly fork: boolean;
+ readonly forks: number;
+ readonly forks_count: number;
+ /** Format: uri */
+ readonly forks_url: string;
+ readonly full_name: string;
+ /** Format: uri-template */
+ readonly git_commits_url: string;
+ /** Format: uri-template */
+ readonly git_refs_url: string;
+ /** Format: uri-template */
+ readonly git_tags_url: string;
+ /** Format: uri */
+ readonly git_url: string;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ readonly has_issues: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ readonly has_wiki: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ readonly has_discussions: boolean;
+ readonly homepage: string | null;
+ /** Format: uri */
+ readonly hooks_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ readonly is_template?: boolean;
+ /** Format: uri-template */
+ readonly issue_comment_url: string;
+ /** Format: uri-template */
+ readonly issue_events_url: string;
/** Format: uri-template */
- readonly following_url?: string;
+ readonly issues_url: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
+ readonly keys_url: string;
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly language: string | null;
/** Format: uri */
- readonly received_events_url?: string;
+ readonly languages_url: string;
+ /** License */
+ readonly license: {
+ readonly key: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly spdx_id: string;
+ /** Format: uri */
+ readonly url: string | null;
+ } | null;
+ readonly master_branch?: string;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ readonly merges_url: string;
/** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly milestones_url: string;
/** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason?: string | null;
- readonly assignee?: Record;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels?: Record[];
- readonly labels_url?: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
+ readonly mirror_url: string | null;
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** Format: uri-template */
+ readonly notifications_url: string;
+ readonly open_issues: number;
+ readonly open_issues_count: number;
+ readonly organization?: string;
/** User */
- readonly creator: {
+ readonly owner: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -44193,76 +36026,185 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly pull: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
+ };
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ readonly public?: boolean;
+ /** Format: uri-template */
+ readonly pulls_url: string;
+ readonly pushed_at: (number | string) | null;
+ /** Format: uri-template */
+ readonly releases_url: string;
+ readonly role_name?: string | null;
+ readonly size: number;
/**
- * @description The state of the milestone.
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
+ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ readonly ssh_url: string;
+ readonly stargazers?: number;
+ readonly stargazers_count: number;
+ /** Format: uri */
+ readonly stargazers_url: string;
+ /** Format: uri-template */
+ readonly statuses_url: string;
+ /** Format: uri */
+ readonly subscribers_url: string;
+ /** Format: uri */
+ readonly subscription_url: string;
+ /** Format: uri */
+ readonly svn_url: string;
+ /** Format: uri */
+ readonly tags_url: string;
+ /** Format: uri */
+ readonly teams_url: string;
+ readonly topics: string[];
+ /** Format: uri-template */
+ readonly trees_url: string;
/** Format: date-time */
readonly updated_at: string;
/** Format: uri */
readonly url: string;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default.
+ * @default false
+ */
+ readonly use_squash_pr_title_as_default: boolean;
+ /** @enum {string} */
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
};
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- readonly state?: string;
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
+ readonly sha: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
readonly events_url?: string;
+ /** Format: uri */
readonly followers_url?: string;
+ /** Format: uri-template */
readonly following_url?: string;
+ /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
+ /** Format: uri */
readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
readonly node_id?: string;
+ /** Format: uri */
readonly organizations_url?: string;
+ /** Format: uri */
readonly received_events_url?: string;
+ /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
+ /** Format: uri-template */
readonly starred_url?: string;
+ /** Format: uri */
readonly subscriptions_url?: string;
- readonly type?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
readonly url?: string;
- };
+ } | null;
};
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly issue_url: string;
+ readonly labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ readonly locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ readonly maintainer_can_modify?: boolean;
+ readonly merge_commit_sha: string | null;
+ readonly mergeable?: boolean | null;
+ readonly mergeable_state?: string;
+ readonly merged?: boolean | null;
+ /** Format: date-time */
+ readonly merged_at: string | null;
+ /** User */
+ readonly merged_by?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
@@ -44333,875 +36275,1231 @@ export interface components {
readonly updated_at: string;
/** Format: uri */
readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues opened event */
- readonly "webhook-issues-opened": {
- /** @enum {string} */
- readonly action: "opened";
- readonly changes?: {
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly old_issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
+ } | null;
+ readonly node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ readonly number: number;
+ /** Format: uri */
+ readonly patch_url: string;
+ readonly rebaseable?: boolean | null;
+ readonly requested_reviewers: (({
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null) | {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repository_url: string;
+ readonly repositories_url: string;
+ readonly slug: string;
/**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
+ * Format: uri
+ * @description URL for the team
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ readonly url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
+ /** @enum {string} */
+ readonly privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url?: string;
+ })[];
+ readonly requested_teams: {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
/** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
/**
* Format: uri
- * @description URL for the issue
+ * @description URL for the team
*/
readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
} | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
+ /** @enum {string} */
+ readonly privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
/**
- * Repository
- * @description A git repository
+ * Format: uri
+ * @description URL for the team
*/
- readonly old_repository: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ readonly url?: string;
+ }[];
+ /** Format: uri-template */
+ readonly review_comment_url: string;
+ readonly review_comments?: number;
+ /** Format: uri */
+ readonly review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** Format: uri */
+ readonly statuses_url: string;
+ /** @description The title of the pull request. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ /**
+ * Pull Request Review Comment
+ * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.
+ */
+ readonly webhooks_review_comment: {
+ readonly _links: {
+ /** Link */
+ readonly html: {
/** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
+ readonly href: string;
+ };
+ /** Link */
+ readonly pull_request: {
/** Format: uri-template */
- readonly assignees_url: string;
+ readonly href: string;
+ };
+ /** Link */
+ readonly self: {
+ /** Format: uri-template */
+ readonly href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description The text of the comment. */
+ readonly body: string;
+ /** @description The SHA of the commit to which the comment applies. */
+ readonly commit_id: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** @description The diff of the line that the comment refers to. */
+ readonly diff_hunk: string;
+ /**
+ * Format: uri
+ * @description HTML URL for the pull request review comment.
+ */
+ readonly html_url: string;
+ /** @description The ID of the pull request review comment. */
+ readonly id: number;
+ /** @description The comment ID to reply to. */
+ readonly in_reply_to_id?: number;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ readonly line: number | null;
+ /** @description The node ID of the pull request review comment. */
+ readonly node_id: string;
+ /** @description The SHA of the original commit to which the comment applies. */
+ readonly original_commit_id: string;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ readonly original_line: number;
+ /** @description The index of the original line in the diff to which the comment applies. */
+ readonly original_position: number;
+ /** @description The first line of the range for a multi-line comment. */
+ readonly original_start_line: number | null;
+ /** @description The relative path of the file to which the comment applies. */
+ readonly path: string;
+ /** @description The line index in the diff to which the comment applies. */
+ readonly position: number | null;
+ /** @description The ID of the pull request review to which the comment belongs. */
+ readonly pull_request_review_id: number | null;
+ /**
+ * Format: uri
+ * @description URL for the pull request that the review comment belongs to.
+ */
+ readonly pull_request_url: string;
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @enum {string}
+ */
+ readonly side: "LEFT" | "RIGHT";
+ /** @description The first line of the range for a multi-line comment. */
+ readonly start_line: number | null;
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @default RIGHT
+ * @enum {string|null}
+ */
+ readonly start_side: "LEFT" | "RIGHT" | null;
+ /**
+ * @description The level at which the comment is targeted, can be a diff line or a file.
+ * @enum {string}
+ */
+ readonly subject_type?: "line" | "file";
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the pull request review comment
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ /** @description The review that was affected. */
+ readonly webhooks_review: {
+ readonly _links: {
+ /** Link */
+ readonly html: {
/** Format: uri-template */
- readonly blobs_url: string;
+ readonly href: string;
+ };
+ /** Link */
+ readonly pull_request: {
/** Format: uri-template */
- readonly branches_url: string;
+ readonly href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description The text of the review. */
+ readonly body: string | null;
+ /** @description A commit SHA for the review. */
+ readonly commit_id: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the review */
+ readonly id: number;
+ readonly node_id: string;
+ /** Format: uri */
+ readonly pull_request_url: string;
+ readonly state: string;
+ /** Format: date-time */
+ readonly submitted_at: string | null;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ };
+ readonly webhooks_nullable_string: string | null;
+ /**
+ * Release
+ * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
+ */
+ readonly webhooks_release: {
+ readonly assets: {
+ /** Format: uri */
+ readonly browser_download_url: string;
+ readonly content_type: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly download_count: number;
+ readonly id: number;
+ readonly label: string | null;
+ /** @description The file name of the asset. */
+ readonly name: string;
+ readonly node_id: string;
+ readonly size: number;
+ /**
+ * @description State of the release asset.
+ * @enum {string}
+ */
+ readonly state: "uploaded";
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** User */
+ readonly uploader?: {
/** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly commits_url: string;
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
/** Format: uri-template */
- readonly compare_url: string;
+ readonly following_url?: string;
/** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
- };
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly downloads_url: string;
+ readonly organizations_url?: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ readonly received_events_url?: string;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly git_tags_url: string;
- /** Format: uri */
- readonly git_url: string;
- /** @description Whether the repository has discussions enabled. */
- readonly has_discussions?: boolean;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
- readonly homepage: string | null;
- /** Format: uri */
- readonly hooks_url: string;
+ readonly starred_url?: string;
/** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
- /** Format: uri-template */
- readonly issues_url: string;
- /** Format: uri-template */
- readonly keys_url: string;
- /** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
+ readonly url?: string;
+ } | null;
+ /** Format: uri */
+ readonly url: string;
+ }[];
+ /** Format: uri */
+ readonly assets_url: string;
+ /** User */
+ readonly author: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly created_at: string | null;
+ /** Format: uri */
+ readonly discussion_url?: string;
+ /** @description Whether the release is a draft or published */
+ readonly draft: boolean;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string | null;
+ readonly node_id: string;
+ /** @description Whether the release is identified as a prerelease or a full release. */
+ readonly prerelease: boolean;
+ /** Format: date-time */
+ readonly published_at: string | null;
+ /** Reactions */
+ readonly reactions?: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** @description The name of the tag. */
+ readonly tag_name: string;
+ /** Format: uri */
+ readonly tarball_url: string | null;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. */
+ readonly target_commitish: string;
+ /** Format: uri-template */
+ readonly upload_url: string;
+ /** Format: uri */
+ readonly url: string;
+ /** Format: uri */
+ readonly zipball_url: string | null;
+ };
+ /**
+ * Release
+ * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
+ */
+ readonly webhooks_release_1: {
+ readonly assets: ({
+ /** Format: uri */
+ readonly browser_download_url: string;
+ readonly content_type: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly download_count: number;
+ readonly id: number;
+ readonly label: string | null;
+ /** @description The file name of the asset. */
+ readonly name: string;
+ readonly node_id: string;
+ readonly size: number;
+ /**
+ * @description State of the release asset.
+ * @enum {string}
+ */
+ readonly state: "uploaded";
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** User */
+ readonly uploader?: {
/** Format: uri */
- readonly merges_url: string;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly milestones_url: string;
+ readonly events_url?: string;
/** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
- /** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- };
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ readonly followers_url?: string;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
+ readonly following_url?: string;
/** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly subscription_url: string;
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly svn_url: string;
+ readonly organizations_url?: string;
/** Format: uri */
- readonly tags_url: string;
+ readonly received_events_url?: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly starred_url?: string;
/** Format: uri */
- readonly url: string;
+ readonly subscriptions_url?: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require commit signoff. */
- readonly web_commit_signoff_required?: boolean;
- };
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** Format: uri */
+ readonly url: string;
+ } | null)[];
+ /** Format: uri */
+ readonly assets_url: string;
+ /** User */
+ readonly author: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly created_at: string | null;
+ /** Format: uri */
+ readonly discussion_url?: string;
+ /** @description Whether the release is a draft or published */
+ readonly draft: boolean;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string | null;
+ readonly node_id: string;
+ /** @description Whether the release is identified as a prerelease or a full release. */
+ readonly prerelease: boolean;
+ /** Format: date-time */
+ readonly published_at: string | null;
+ /** Reactions */
+ readonly reactions?: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ /** @description The name of the tag. */
+ readonly tag_name: string;
+ /** Format: uri */
+ readonly tarball_url: string | null;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. */
+ readonly target_commitish: string;
+ /** Format: uri-template */
+ readonly upload_url: string;
+ /** Format: uri */
+ readonly url: string;
+ /** Format: uri */
+ readonly zipball_url: string | null;
+ };
+ /**
+ * Repository Vulnerability Alert Alert
+ * @description The security alert of the vulnerable dependency.
+ */
+ readonly webhooks_alert: {
+ readonly affected_package_name: string;
+ readonly affected_range: string;
+ readonly created_at: string;
+ readonly dismiss_reason?: string;
+ readonly dismissed_at?: string;
+ /** User */
+ readonly dismisser?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly external_identifier: string;
+ /** Format: uri */
+ readonly external_reference: string | null;
+ readonly fix_reason?: string;
+ /** Format: date-time */
+ readonly fixed_at?: string;
+ readonly fixed_in?: string;
+ readonly ghsa_id: string;
+ readonly id: number;
+ readonly node_id: string;
+ readonly number: number;
+ readonly severity: string;
+ /** @enum {string} */
+ readonly state: "open";
+ };
+ /**
+ * @description The reason for resolving the alert.
+ * @enum {string|null}
+ */
+ readonly "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited";
+ readonly "secret-scanning-alert-webhook": {
+ readonly number?: components["schemas"]["alert-number"];
+ readonly created_at?: components["schemas"]["alert-created-at"];
+ readonly updated_at?: components["schemas"]["nullable-alert-updated-at"];
+ readonly url?: components["schemas"]["alert-url"];
+ readonly html_url?: components["schemas"]["alert-html-url"];
/**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ * Format: uri
+ * @description The REST API URL of the code locations for this alert.
*/
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
+ readonly locations_url?: string;
+ readonly resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"];
+ /**
+ * Format: date-time
+ * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ readonly resolved_at?: string | null;
+ readonly resolved_by?: components["schemas"]["nullable-simple-user"];
+ /** @description An optional comment to resolve an alert. */
+ readonly resolution_comment?: string | null;
+ /** @description The type of secret that secret scanning detected. */
+ readonly secret_type?: string;
+ /**
+ * @description The token status as of the latest validity check.
+ * @enum {string}
+ */
+ readonly validity?: "active" | "inactive" | "unknown";
+ /** @description Whether push protection was bypassed for the detected secret. */
+ readonly push_protection_bypassed?: boolean | null;
+ readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"];
+ /**
+ * Format: date-time
+ * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ readonly push_protection_bypassed_at?: string | null;
+ };
+ /** @description The details of the security advisory, including summary, description, and severity. */
+ readonly webhooks_security_advisory: {
+ readonly cvss: {
+ readonly score: number;
+ readonly vector_string: string | null;
+ };
+ readonly cwes: {
+ readonly cwe_id: string;
+ readonly name: string;
+ }[];
+ readonly description: string;
+ readonly ghsa_id: string;
+ readonly identifiers: {
+ readonly type: string;
+ readonly value: string;
+ }[];
+ readonly published_at: string;
+ readonly references: {
+ /** Format: uri */
+ readonly url: string;
+ }[];
+ readonly severity: string;
+ readonly summary: string;
+ readonly updated_at: string;
+ readonly vulnerabilities: {
+ readonly first_patched_version: {
+ readonly identifier: string;
} | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ readonly package: {
+ readonly ecosystem: string;
+ readonly name: string;
+ };
+ readonly severity: string;
+ readonly vulnerable_version_range: string;
+ }[];
+ readonly withdrawn_at: string | null;
+ };
+ readonly webhooks_sponsorship: {
+ readonly created_at: string;
+ readonly maintainer?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
+ readonly node_id: string;
+ readonly privacy_level: string;
+ /** User */
+ readonly sponsor: {
/** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
/** Format: uri */
- readonly events_url: string;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
+ readonly html_url?: string;
readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** User */
+ readonly sponsorable: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /**
+ * Sponsorship Tier
+ * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
+ */
+ readonly tier: {
+ readonly created_at: string;
+ readonly description: string;
+ readonly is_custom_ammount?: boolean;
+ readonly is_custom_amount?: boolean;
+ readonly is_one_time: boolean;
+ readonly monthly_price_in_cents: number;
+ readonly monthly_price_in_dollars: number;
+ readonly name: string;
+ readonly node_id: string;
+ };
+ };
+ /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */
+ readonly webhooks_effective_date: string;
+ readonly webhooks_changes_8: {
+ readonly tier: {
/**
- * Milestone
- * @description A collection of related issues and pull requests.
+ * Sponsorship Tier
+ * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
*/
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
+ readonly from: {
readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
+ readonly description: string;
+ readonly is_custom_ammount?: boolean;
+ readonly is_custom_amount?: boolean;
+ readonly is_one_time: boolean;
+ readonly monthly_price_in_cents: number;
+ readonly monthly_price_in_dollars: number;
+ readonly name: string;
readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
+ };
+ };
+ };
+ /**
+ * Team
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ readonly webhooks_team_1: {
+ readonly deleted?: boolean;
+ /** @description Description of the team */
+ readonly description?: string | null;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url?: string;
+ /** @description Name of the team */
+ readonly name: string;
+ readonly node_id?: string;
+ readonly parent?: {
+ /** @description Description of the team */
+ readonly description: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the team */
+ readonly id: number;
+ /** Format: uri-template */
+ readonly members_url: string;
+ /** @description Name of the team */
+ readonly name: string;
readonly node_id: string;
- readonly number: number;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission: string;
+ /** @enum {string} */
+ readonly privacy: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ readonly notification_setting: "notifications_enabled" | "notifications_disabled";
+ /** Format: uri */
+ readonly repositories_url: string;
+ readonly slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ readonly permission?: string;
+ /** @enum {string} */
+ readonly privacy?: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
+ /** Format: uri */
+ readonly repositories_url?: string;
+ readonly slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ readonly url?: string;
+ };
+ /** branch protection configuration disabled event */
+ readonly "webhook-branch-protection-configuration-disabled": {
+ /** @enum {string} */
+ readonly action: "disabled";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** branch protection configuration enabled event */
+ readonly "webhook-branch-protection-configuration-enabled": {
+ /** @enum {string} */
+ readonly action: "enabled";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** branch protection rule created event */
+ readonly "webhook-branch-protection-rule-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly rule: components["schemas"]["webhooks_rule"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** branch protection rule deleted event */
+ readonly "webhook-branch-protection-rule-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly rule: components["schemas"]["webhooks_rule"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** branch protection rule edited event */
+ readonly "webhook-branch-protection-rule-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ /** @description If the action was `edited`, the changes to the rule. */
+ readonly changes?: {
+ readonly admin_enforced?: {
+ readonly from: boolean | null;
+ };
+ readonly authorized_actor_names?: {
+ readonly from: string[];
+ };
+ readonly authorized_actors_only?: {
+ readonly from: boolean | null;
+ };
+ readonly authorized_dismissal_actors_only?: {
+ readonly from: boolean | null;
+ };
+ readonly linear_history_requirement_enforcement_level?: {
+ /** @enum {string} */
+ readonly from: "off" | "non_admins" | "everyone";
+ };
+ readonly required_status_checks?: {
+ readonly from: string[];
+ };
+ readonly required_status_checks_enforcement_level?: {
+ /** @enum {string} */
+ readonly from: "off" | "non_admins" | "everyone";
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly rule: components["schemas"]["webhooks_rule"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Check Run Completed Event */
+ readonly "webhook-check-run-completed": {
+ /** @enum {string} */
+ readonly action?: "completed";
+ readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * Check Run Completed Event
+ * @description The check_run.completed webhook encoded with URL encoding
+ */
+ readonly "webhook-check-run-completed-form-encoded": {
+ /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */
+ readonly payload: string;
+ };
+ /** Check Run Created Event */
+ readonly "webhook-check-run-created": {
+ /** @enum {string} */
+ readonly action?: "created";
+ readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * Check Run Created Event
+ * @description The check_run.created webhook encoded with URL encoding
+ */
+ readonly "webhook-check-run-created-form-encoded": {
+ /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */
+ readonly payload: string;
+ };
+ /** Check Run Requested Action Event */
+ readonly "webhook-check-run-requested-action": {
+ /** @enum {string} */
+ readonly action: "requested_action";
+ readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ /** @description The action requested by the user. */
+ readonly requested_action?: {
+ /** @description The integrator reference of the action requested by the user. */
+ readonly identifier?: string;
+ };
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * Check Run Requested Action Event
+ * @description The check_run.requested_action webhook encoded with URL encoding
+ */
+ readonly "webhook-check-run-requested-action-form-encoded": {
+ /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */
+ readonly payload: string;
+ };
+ /** Check Run Re-Requested Event */
+ readonly "webhook-check-run-rerequested": {
+ /** @enum {string} */
+ readonly action?: "rerequested";
+ readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * Check Run Re-Requested Event
+ * @description The check_run.rerequested webhook encoded with URL encoding
+ */
+ readonly "webhook-check-run-rerequested-form-encoded": {
+ /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */
+ readonly payload: string;
+ };
+ /** check_suite completed event */
+ readonly "webhook-check-suite-completed": {
+ /** @enum {string} */
+ readonly action: "completed";
+ /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
+ readonly check_suite: {
+ readonly after: string | null;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ readonly app: {
/** Format: date-time */
readonly created_at: string | null;
readonly description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[];
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[];
/** Format: uri */
readonly external_url: string | null;
/** Format: uri */
@@ -45301,7 +37599,7 @@ export interface components {
/** @enum {string} */
readonly repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ readonly repository_projects?: "read" | "write" | "admin";
/** @enum {string} */
readonly secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
@@ -45325,232 +37623,135 @@ export interface components {
readonly slug?: string;
/** Format: date-time */
readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
};
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
+ readonly before: string | null;
+ /** Format: uri */
+ readonly check_runs_url: string;
+ /**
+ * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.
+ * @enum {string|null}
+ */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure";
+ /** Format: date-time */
+ readonly created_at: string;
+ /** @description The head branch name the changes are on. */
+ readonly head_branch: string | null;
+ /** SimpleCommit */
+ readonly head_commit: {
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly author: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly committer: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ readonly id: string;
+ readonly message: string;
+ readonly timestamp: string;
+ readonly tree_id: string;
+ };
+ /** @description The SHA of the head commit that is being checked. */
+ readonly head_sha: string;
+ readonly id: number;
+ readonly latest_check_runs_count: number;
+ readonly node_id: string;
+ /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly id: number;
+ readonly number: number;
/** Format: uri */
readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
+ }[];
+ readonly rerequestable?: boolean;
+ readonly runs_rerequestable?: boolean;
/**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
+ * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
+ * @enum {string|null}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | null | "pending";
/** Format: date-time */
readonly updated_at: string;
/**
* Format: uri
- * @description URL for the issue
+ * @description URL that points to the check suite API resource.
*/
readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
};
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** issues pinned event */
- readonly "webhook-issues-pinned": {
+ /** check_suite requested event */
+ readonly "webhook-check-suite-requested": {
/** @enum {string} */
- readonly action: "pinned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
+ readonly action: "requested";
+ /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
+ readonly check_suite: {
+ readonly after: string | null;
/**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
+ readonly app: {
+ /** Format: date-time */
+ readonly created_at: string | null;
readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
readonly name: string;
readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
/** User */
- readonly creator: {
+ readonly owner: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -45586,42 +37787,201 @@ export interface components {
/** Format: uri */
readonly url?: string;
} | null;
- readonly description: string | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
/** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
+ readonly updated_at: string | null;
+ };
+ readonly before: string | null;
+ /** Format: uri */
+ readonly check_runs_url: string;
+ /**
+ * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.
+ * @enum {string|null}
+ */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped";
+ /** Format: date-time */
+ readonly created_at: string;
+ /** @description The head branch name the changes are on. */
+ readonly head_branch: string | null;
+ /** SimpleCommit */
+ readonly head_commit: {
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly author: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly committer: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ readonly id: string;
+ readonly message: string;
+ readonly timestamp: string;
+ readonly tree_id: string;
+ };
+ /** @description The SHA of the head commit that is being checked. */
+ readonly head_sha: string;
+ readonly id: number;
+ readonly latest_check_runs_count: number;
+ readonly node_id: string;
+ /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
/** Format: uri */
readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
+ }[];
+ readonly rerequestable?: boolean;
+ readonly runs_rerequestable?: boolean;
+ /**
+ * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
+ * @enum {string|null}
+ */
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | null;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL that points to the check suite API resource.
+ */
+ readonly url: string;
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** check_suite rerequested event */
+ readonly "webhook-check-suite-rerequested": {
+ /** @enum {string} */
+ readonly action: "rerequested";
+ /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
+ readonly check_suite: {
+ readonly after: string | null;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ readonly app: {
/** Format: date-time */
readonly created_at: string | null;
readonly description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[];
/** Format: uri */
readonly external_url: string | null;
/** Format: uri */
@@ -45705,7 +38065,7 @@ export interface components {
/** @enum {string} */
readonly organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write";
+ readonly organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
readonly organization_secrets?: "read" | "write";
/** @enum {string} */
@@ -45721,7 +38081,7 @@ export interface components {
/** @enum {string} */
readonly repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ readonly repository_projects?: "read" | "write" | "admin";
/** @enum {string} */
readonly secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
@@ -45745,54 +38105,125 @@ export interface components {
readonly slug?: string;
/** Format: date-time */
readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
};
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
+ readonly before: string | null;
+ /** Format: uri */
+ readonly check_runs_url: string;
+ /**
+ * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.
+ * @enum {string|null}
+ */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** @description The head branch name the changes are on. */
+ readonly head_branch: string | null;
+ /** SimpleCommit */
+ readonly head_commit: {
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly author: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ readonly committer: {
+ /** Format: date-time */
+ readonly date?: string;
+ /** Format: email */
+ readonly email: string | null;
+ /** @description The git author's name. */
+ readonly name: string;
+ readonly username?: string;
+ };
+ readonly id: string;
+ readonly message: string;
+ readonly timestamp: string;
+ readonly tree_id: string;
+ };
+ /** @description The SHA of the head commit that is being checked. */
+ readonly head_sha: string;
+ readonly id: number;
+ readonly latest_check_runs_count: number;
+ readonly node_id: string;
+ /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly id: number;
+ readonly number: number;
/** Format: uri */
readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
+ }[];
+ readonly rerequestable?: boolean;
+ readonly runs_rerequestable?: boolean;
/**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
+ * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
+ * @enum {string|null}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | null;
/** Format: date-time */
readonly updated_at: string;
/**
* Format: uri
- * @description URL for the issue
+ * @description URL that points to the check suite API resource.
*/
readonly url: string;
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert appeared_in_branch event */
+ readonly "webhook-code-scanning-alert-appeared-in-branch": {
+ /** @enum {string} */
+ readonly action: "appeared_in_branch";
+ /** @description The code scanning alert involved in the event. */
+ readonly alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ readonly dismissed_at: string | null;
/** User */
- readonly user: {
+ readonly dismissed_by: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -45828,22 +38259,97 @@ export interface components {
/** Format: uri */
readonly url?: string;
} | null;
+ /**
+ * @description The reason for dismissing or closing the alert.
+ * @enum {string|null}
+ */
+ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ readonly html_url: string;
+ /** Alert Instance */
+ readonly most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ readonly analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ readonly category?: string;
+ readonly classifications?: string[];
+ readonly commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ readonly environment: string;
+ readonly location?: {
+ readonly end_column?: number;
+ readonly end_line?: number;
+ readonly path?: string;
+ readonly start_column?: number;
+ readonly start_line?: number;
+ };
+ readonly message?: {
+ readonly text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ readonly ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ readonly number: number;
+ readonly rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description: string;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity: "none" | "note" | "warning" | "error" | null;
+ };
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "open" | "dismissed" | "fixed";
+ readonly tool: {
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ readonly name: string;
+ /** @description The version of the tool used to detect the alert. */
+ readonly version: string | null;
+ };
+ /** Format: uri */
+ readonly url: string;
};
+ readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** issues reopened event */
- readonly "webhook-issues-reopened": {
+ /** code_scanning_alert closed_by_user event */
+ readonly "webhook-code-scanning-alert-closed-by-user": {
/** @enum {string} */
- readonly action: "reopened";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly action: "closed_by_user";
+ /** @description The code scanning alert involved in the event. */
+ readonly alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ readonly dismissed_at: string;
/** User */
- readonly assignee?: {
+ readonly dismissed_by: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -45879,7 +38385,199 @@ export interface components {
/** Format: uri */
readonly url?: string;
} | null;
- readonly assignees: ({
+ /**
+ * @description The reason for dismissing or closing the alert.
+ * @enum {string|null}
+ */
+ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ readonly html_url: string;
+ /** Alert Instance */
+ readonly most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ readonly analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ readonly category?: string;
+ readonly classifications?: string[];
+ readonly commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ readonly environment: string;
+ readonly location?: {
+ readonly end_column?: number;
+ readonly end_line?: number;
+ readonly path?: string;
+ readonly start_column?: number;
+ readonly start_line?: number;
+ };
+ readonly message?: {
+ readonly text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ readonly ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ readonly number: number;
+ readonly rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description: string;
+ readonly full_description?: string;
+ readonly help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ readonly help_uri?: string | null;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id: string;
+ readonly name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity: "none" | "note" | "warning" | "error" | null;
+ readonly tags?: string[] | null;
+ };
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "dismissed" | "fixed";
+ readonly tool: {
+ readonly guid?: string | null;
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ readonly name: string;
+ /** @description The version of the tool used to detect the alert. */
+ readonly version: string | null;
+ };
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert created event */
+ readonly "webhook-code-scanning-alert-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ /** @description The code scanning alert involved in the event. */
+ readonly alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ readonly created_at: string | null;
+ /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ readonly dismissed_at: unknown;
+ readonly dismissed_by: unknown;
+ readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
+ readonly dismissed_reason: unknown;
+ readonly fixed_at?: unknown;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ readonly html_url: string;
+ readonly instances_url?: string;
+ /** Alert Instance */
+ readonly most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ readonly analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ readonly category?: string;
+ readonly classifications?: string[];
+ readonly commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ readonly environment: string;
+ readonly location?: {
+ readonly end_column?: number;
+ readonly end_line?: number;
+ readonly path?: string;
+ readonly start_column?: number;
+ readonly start_line?: number;
+ };
+ readonly message?: {
+ readonly text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ readonly ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ readonly number: number;
+ readonly rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description: string;
+ readonly full_description?: string;
+ readonly help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ readonly help_uri?: string | null;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id: string;
+ readonly name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity: "none" | "note" | "warning" | "error" | null;
+ readonly tags?: string[] | null;
+ };
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "open" | "dismissed";
+ readonly tool: {
+ readonly guid?: string | null;
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ readonly name: string;
+ /** @description The version of the tool used to detect the alert. */
+ readonly version: string | null;
+ } | null;
+ readonly updated_at?: string | null;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert fixed event */
+ readonly "webhook-code-scanning-alert-fixed": {
+ /** @enum {string} */
+ readonly action: "fixed";
+ /** @description The code scanning alert involved in the event. */
+ readonly alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ readonly created_at: string;
+ /**
+ * Format: date-time
+ * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ readonly dismissed_at: string | null;
+ /** User */
+ readonly dismissed_by: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -45911,271 +38609,303 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null)[];
+ } | null;
/**
- * AuthorAssociation
- * @description How the author is associated with the repository.
+ * @description The reason for dismissing or closing the alert.
+ * @enum {string|null}
+ */
+ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ readonly html_url: string;
+ /** Format: uri */
+ readonly instances_url?: string;
+ /** Alert Instance */
+ readonly most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ readonly analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ readonly category?: string;
+ readonly classifications?: string[];
+ readonly commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ readonly environment: string;
+ readonly location?: {
+ readonly end_column?: number;
+ readonly end_line?: number;
+ readonly path?: string;
+ readonly start_column?: number;
+ readonly start_line?: number;
+ };
+ readonly message?: {
+ readonly text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ readonly ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ readonly state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ readonly number: number;
+ readonly rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description: string;
+ readonly full_description?: string;
+ readonly help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ readonly help_uri?: string | null;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id: string;
+ readonly name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity: "none" | "note" | "warning" | "error" | null;
+ readonly tags?: string[] | null;
+ };
+ /**
+ * @description State of a code scanning alert.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ readonly state: "fixed";
+ readonly tool: {
+ readonly guid?: string | null;
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ readonly name: string;
+ /** @description The version of the tool used to detect the alert. */
+ readonly version: string | null;
+ };
/** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
+ readonly url: string;
+ };
+ readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert reopened event */
+ readonly "webhook-code-scanning-alert-reopened": {
+ /** @enum {string} */
+ readonly action: "reopened";
+ /** @description The code scanning alert involved in the event. */
+ readonly alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
+ /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ readonly dismissed_at: string | null;
+ readonly dismissed_by: Record;
+ /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
+ readonly dismissed_reason: string | null;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ /** Alert Instance */
+ readonly most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ readonly analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ readonly category?: string;
+ readonly classifications?: string[];
+ readonly commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ readonly environment: string;
+ readonly location?: {
+ readonly end_column?: number;
+ readonly end_line?: number;
+ readonly path?: string;
+ readonly start_column?: number;
+ readonly start_line?: number;
+ };
+ readonly message?: {
+ readonly text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ readonly ref: string;
/**
- * Format: uri
- * @description URL for the label
+ * @description State of a code scanning alert.
+ * @enum {string}
*/
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ readonly state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ readonly number: number;
+ readonly rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description: string;
+ readonly full_description?: string;
+ readonly help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ readonly help_uri?: string | null;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id: string;
+ readonly name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity: "none" | "note" | "warning" | "error" | null;
+ readonly tags?: string[] | null;
+ };
/**
- * Milestone
- * @description A collection of related issues and pull requests.
+ * @description State of a code scanning alert.
+ * @enum {string}
*/
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ readonly state: "open" | "dismissed" | "fixed";
+ readonly tool: {
+ readonly guid?: string | null;
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ readonly name: string;
+ /** @description The version of the tool used to detect the alert. */
+ readonly version: string | null;
+ };
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
+ readonly commit_oid: string | null;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
+ readonly ref: string | null;
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert reopened_by_user event */
+ readonly "webhook-code-scanning-alert-reopened-by-user": {
+ /** @enum {string} */
+ readonly action: "reopened_by_user";
+ /** @description The code scanning alert involved in the event. */
+ readonly alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ readonly created_at: string;
+ /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ readonly dismissed_at: unknown;
+ readonly dismissed_by: unknown;
+ /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
+ readonly dismissed_reason: unknown;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ readonly html_url: string;
+ /** Alert Instance */
+ readonly most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ readonly analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ readonly category?: string;
+ readonly classifications?: string[];
+ readonly commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ readonly environment: string;
+ readonly location?: {
+ readonly end_column?: number;
+ readonly end_line?: number;
+ readonly path?: string;
+ readonly start_column?: number;
+ readonly start_line?: number;
+ };
+ readonly message?: {
+ readonly text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ readonly ref: string;
/**
- * @description The state of the milestone.
+ * @description State of a code scanning alert.
* @enum {string}
*/
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
+ readonly state: "open" | "dismissed" | "fixed";
} | null;
- readonly node_id: string;
+ /** @description The code scanning alert number. */
readonly number: number;
+ readonly rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ readonly description: string;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ readonly id: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ readonly severity: "none" | "note" | "warning" | "error" | null;
+ };
/**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ * @description State of a code scanning alert.
+ * @enum {string}
*/
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
+ readonly state: "open" | "fixed";
+ readonly tool: {
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
+ /** @description The version of the tool used to detect the alert. */
+ readonly version: string | null;
};
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** commit_comment created event */
+ readonly "webhook-commit-comment-created": {
+ /**
+ * @description The action performed. Can be `created`.
+ * @enum {string}
+ */
+ readonly action: "created";
+ /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */
+ readonly comment: {
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description The text of the comment. */
+ readonly body: string;
+ /** @description The SHA of the commit to which the comment applies. */
+ readonly commit_id: string;
+ readonly created_at: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description The ID of the commit comment. */
+ readonly id: number;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ readonly line: number | null;
+ /** @description The node ID of the commit comment. */
+ readonly node_id: string;
+ /** @description The relative path of the file to which the comment applies. */
+ readonly path: string | null;
+ /** @description The line index in the diff to which the comment applies. */
+ readonly position: number | null;
/** Reactions */
- readonly reactions: {
+ readonly reactions?: {
readonly "+1": number;
readonly "-1": number;
readonly confused: number;
@@ -46188,24 +38918,8 @@ export interface components {
/** Format: uri */
readonly url: string;
};
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
+ /** Format: uri */
readonly url: string;
/** User */
readonly user: {
@@ -46240,453 +38954,271 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
- } & {
- readonly active_lock_reason?: string | null;
- readonly assignee?: Record;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels?: Record[];
- readonly labels_url?: string;
- readonly locked?: boolean;
- readonly milestone?: Record;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- /** @enum {string} */
- readonly state: "open" | "closed";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
};
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** issues transferred event */
- readonly "webhook-issues-transferred": {
+ /** create event */
+ readonly "webhook-create": {
+ /** @description The repository's current description. */
+ readonly description: string | null;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ /** @description The name of the repository's default branch (usually `main`). */
+ readonly master_branch: string;
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"];
+ readonly ref: components["schemas"]["webhooks_ref_0"];
+ /**
+ * @description The type of Git ref object created in the repository.
+ * @enum {string}
+ */
+ readonly ref_type: "tag" | "branch";
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** custom property created event */
+ readonly "webhook-custom-property-created": {
/** @enum {string} */
- readonly action: "transferred";
- readonly changes: {
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly new_issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
+ readonly action: "created";
+ readonly definition: components["schemas"]["org-custom-property"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** custom property deleted event */
+ readonly "webhook-custom-property-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly definition: {
+ /** @description The name of the property that was deleted. */
+ readonly property_name: string;
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** custom property updated event */
+ readonly "webhook-custom-property-updated": {
+ /** @enum {string} */
+ readonly action: "updated";
+ readonly definition: components["schemas"]["org-custom-property"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Custom property values updated event */
+ readonly "webhook-custom-property-values-updated": {
+ /** @enum {string} */
+ readonly action: "updated";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ /** @description The new custom property values for the repository. */
+ readonly new_property_values: components["schemas"]["custom-property-value"][];
+ /** @description The old custom property values for the repository. */
+ readonly old_property_values: components["schemas"]["custom-property-value"][];
+ };
+ /** delete event */
+ readonly "webhook-delete": {
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"];
+ readonly ref: components["schemas"]["webhooks_ref_0"];
+ /**
+ * @description The type of Git ref object deleted in the repository.
+ * @enum {string}
+ */
+ readonly ref_type: "tag" | "branch";
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert auto-dismissed event */
+ readonly "webhook-dependabot-alert-auto-dismissed": {
+ /** @enum {string} */
+ readonly action: "auto_dismissed";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert auto-reopened event */
+ readonly "webhook-dependabot-alert-auto-reopened": {
+ /** @enum {string} */
+ readonly action: "auto_reopened";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert created event */
+ readonly "webhook-dependabot-alert-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert dismissed event */
+ readonly "webhook-dependabot-alert-dismissed": {
+ /** @enum {string} */
+ readonly action: "dismissed";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert fixed event */
+ readonly "webhook-dependabot-alert-fixed": {
+ /** @enum {string} */
+ readonly action: "fixed";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert reintroduced event */
+ readonly "webhook-dependabot-alert-reintroduced": {
+ /** @enum {string} */
+ readonly action: "reintroduced";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert reopened event */
+ readonly "webhook-dependabot-alert-reopened": {
+ /** @enum {string} */
+ readonly action: "reopened";
+ readonly alert: components["schemas"]["dependabot-alert"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** deploy_key created event */
+ readonly "webhook-deploy-key-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly key: components["schemas"]["webhooks_deploy_key"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** deploy_key deleted event */
+ readonly "webhook-deploy-key-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly key: components["schemas"]["webhooks_deploy_key"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** deployment created event */
+ readonly "webhook-deployment-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ /**
+ * Deployment
+ * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).
+ */
+ readonly deployment: {
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
/** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
/** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ readonly environment: string;
+ readonly id: number;
+ readonly node_id: string;
+ readonly original_environment: string;
+ readonly payload: Record | string;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
/** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
/** User */
- readonly user: {
+ readonly owner: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -46722,265 +39254,665 @@ export interface components {
/** Format: uri */
readonly url?: string;
} | null;
- };
- /**
- * Repository
- * @description A git repository
- */
- readonly new_repository: {
- /**
- * @description Whether to allow auto-merge for pull requests.
- * @default false
- */
- readonly allow_auto_merge: boolean;
- /** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- */
- readonly allow_merge_commit: boolean;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- */
- readonly allow_rebase_merge: boolean;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- */
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly production_environment?: boolean;
+ readonly ref: string;
+ /** Format: uri */
+ readonly repository_url: string;
+ readonly sha: string;
+ /** Format: uri */
+ readonly statuses_url: string;
+ readonly task: string;
+ readonly transient_environment?: boolean;
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly workflow: components["schemas"]["webhooks_workflow"];
+ /** Deployment Workflow Run */
+ readonly workflow_run: {
+ /** User */
+ readonly actor: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly archive_url: string;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- readonly archived: boolean;
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
/** Format: uri-template */
- readonly assignees_url: string;
+ readonly following_url?: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly branches_url: string;
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly artifacts_url?: string;
+ readonly cancel_url?: string;
+ readonly check_suite_id: number;
+ readonly check_suite_node_id: string;
+ readonly check_suite_url?: string;
+ /** @enum {string|null} */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly display_title: string;
+ readonly event: string;
+ readonly head_branch: string;
+ readonly head_commit?: unknown;
+ readonly head_repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: unknown;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
+ };
+ readonly head_sha: string;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly jobs_url?: string;
+ readonly logs_url?: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly path: string;
+ readonly previous_attempt_url?: unknown;
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly id: number;
+ readonly number: number;
+ /** Format: uri */
+ readonly url: string;
+ }[];
+ readonly referenced_workflows?: {
+ readonly path: string;
+ readonly ref?: string;
+ readonly sha: string;
+ }[] | null;
+ readonly repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: unknown;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
+ };
+ readonly rerun_url?: string;
+ readonly run_attempt: number;
+ readonly run_number: number;
+ /** Format: date-time */
+ readonly run_started_at: string;
+ /** @enum {string} */
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
+ /** User */
+ readonly triggering_actor?: {
/** Format: uri */
- readonly clone_url: string;
- /** Format: uri-template */
- readonly collaborators_url: string;
- /** Format: uri-template */
- readonly comments_url: string;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly commits_url: string;
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
/** Format: uri-template */
- readonly compare_url: string;
+ readonly following_url?: string;
/** Format: uri-template */
- readonly contents_url: string;
- /** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
- /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
- };
- /** @description The default branch of the repository. */
- readonly default_branch: string;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- */
- readonly delete_branch_on_merge: boolean;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
- /** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly downloads_url: string;
+ readonly organizations_url?: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ readonly received_events_url?: string;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
- /** Format: uri-template */
- readonly git_commits_url: string;
- /** Format: uri-template */
- readonly git_refs_url: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly git_tags_url: string;
+ readonly starred_url?: string;
/** Format: uri */
- readonly git_url: string;
- /**
- * @description Whether downloads are enabled.
- * @default true
- */
- readonly has_downloads: boolean;
- /**
- * @description Whether issues are enabled.
- * @default true
- */
- readonly has_issues: boolean;
- readonly has_pages: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- */
- readonly has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- */
- readonly has_wiki: boolean;
- /**
- * @description Whether discussions are enabled.
- * @default false
- */
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly hooks_url: string;
+ readonly url?: string;
+ } | null;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ readonly workflow_id: number;
+ readonly workflow_url?: string;
+ } | null;
+ };
+ /** deployment protection rule requested event */
+ readonly "webhook-deployment-protection-rule-requested": {
+ /** @enum {string} */
+ readonly action?: "requested";
+ /** @description The name of the environment that has the deployment protection rule. */
+ readonly environment?: string;
+ /** @description The event that triggered the deployment protection rule. */
+ readonly event?: string;
+ /**
+ * Format: uri
+ * @description The URL to review the deployment protection rule.
+ */
+ readonly deployment_callback_url?: string;
+ readonly deployment?: components["schemas"]["deployment"];
+ readonly pull_requests?: components["schemas"]["pull-request"][];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ readonly "webhook-deployment-review-approved": {
+ /** @enum {string} */
+ readonly action: "approved";
+ readonly approver?: components["schemas"]["webhooks_approver"];
+ readonly comment?: string;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly reviewers?: components["schemas"]["webhooks_reviewers"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly since: string;
+ readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"];
+ readonly workflow_job_runs?: {
+ readonly conclusion?: unknown;
+ readonly created_at?: string;
+ readonly environment?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly name?: string | null;
+ readonly status?: string;
+ readonly updated_at?: string;
+ }[];
+ /** Deployment Workflow Run */
+ readonly workflow_run: {
+ /** User */
+ readonly actor: {
/** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the repository */
- readonly id: number;
- readonly is_template?: boolean;
- /** Format: uri-template */
- readonly issue_comment_url: string;
- /** Format: uri-template */
- readonly issue_events_url: string;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
/** Format: uri-template */
- readonly issues_url: string;
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
/** Format: uri-template */
- readonly keys_url: string;
+ readonly following_url?: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
/** Format: uri */
- readonly languages_url: string;
- /** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
- /** Format: uri */
- readonly url: string | null;
- } | null;
- readonly master_branch?: string;
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly merges_url: string;
- /** Format: uri-template */
- readonly milestones_url: string;
+ readonly organizations_url?: string;
/** Format: uri */
- readonly mirror_url: string | null;
- /** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
- /** User */
- readonly owner: {
- /** Format: uri */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly artifacts_url?: string;
+ readonly cancel_url?: string;
+ readonly check_suite_id: number;
+ readonly check_suite_node_id: string;
+ readonly check_suite_url?: string;
+ /** @enum {string|null} */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly display_title: string;
+ readonly event: string;
+ readonly head_branch: string;
+ readonly head_commit?: Record;
+ readonly head_repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
+ readonly type?: string;
readonly url?: string;
- } | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
};
- /** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
- /** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
- /** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
- /** Format: uri-template */
- readonly statuses_url: string;
- /** Format: uri */
- readonly subscribers_url: string;
- /** Format: uri */
- readonly subscription_url: string;
- /** Format: uri */
- readonly svn_url: string;
- /** Format: uri */
- readonly tags_url: string;
- /** Format: uri */
- readonly teams_url: string;
- readonly topics: string[];
- /** Format: uri-template */
- readonly trees_url: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
+ };
+ readonly head_sha: string;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly jobs_url?: string;
+ readonly logs_url?: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly path: string;
+ readonly previous_attempt_url?: string | null;
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly id: number;
+ readonly number: number;
/** Format: uri */
readonly url: string;
- /** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
- /** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ }[];
+ readonly referenced_workflows?: {
+ readonly path: string;
+ readonly ref?: string;
+ readonly sha: string;
+ }[] | null;
+ readonly repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
};
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly rerun_url?: string;
+ readonly run_attempt: number;
+ readonly run_number: number;
+ /** Format: date-time */
+ readonly run_started_at: string;
+ /** @enum {string} */
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
/** User */
- readonly assignee?: {
+ readonly triggering_actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47016,7 +39948,41 @@ export interface components {
/** Format: uri */
readonly url?: string;
} | null;
- readonly assignees: ({
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ readonly workflow_id: number;
+ readonly workflow_url?: string;
+ } | null;
+ };
+ readonly "webhook-deployment-review-rejected": {
+ /** @enum {string} */
+ readonly action: "rejected";
+ readonly approver?: components["schemas"]["webhooks_approver"];
+ readonly comment?: string;
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly reviewers?: components["schemas"]["webhooks_reviewers"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly since: string;
+ readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"];
+ readonly workflow_job_runs?: {
+ readonly conclusion?: string | null;
+ readonly created_at?: string;
+ readonly environment?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly name?: string | null;
+ readonly status?: string;
+ readonly updated_at?: string;
+ }[];
+ /** Deployment Workflow Run */
+ readonly workflow_run: {
+ /** User */
+ readonly actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47051,301 +40017,205 @@ export interface components {
readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
+ } | null;
+ readonly artifacts_url?: string;
+ readonly cancel_url?: string;
+ readonly check_suite_id: number;
+ readonly check_suite_node_id: string;
+ readonly check_suite_url?: string;
+ /** @enum {string|null} */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
/** Format: date-time */
readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
+ readonly event: string;
+ readonly head_branch: string;
+ readonly head_commit?: Record;
+ readonly head_repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
+ readonly type?: string;
readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
+ };
+ readonly head_sha: string;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly jobs_url?: string;
+ readonly logs_url?: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly path: string;
+ readonly previous_attempt_url?: string | null;
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
/** Format: uri */
readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
+ }[];
+ readonly referenced_workflows?: {
+ readonly path: string;
+ readonly ref?: string;
+ readonly sha: string;
+ }[] | null;
+ readonly repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
+ readonly type?: string;
readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
};
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
readonly url?: string;
};
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
+ readonly rerun_url?: string;
+ readonly run_attempt: number;
+ readonly run_number: number;
/** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
+ readonly run_started_at: string;
+ /** @enum {string} */
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting";
/** User */
- readonly user: {
+ readonly triggering_actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47353,94 +40223,55 @@ export interface components {
/** Format: uri-template */
readonly events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues unassigned event */
- readonly "webhook-issues-unassigned": {
- /**
- * @description The action that was performed.
- * @enum {string}
- */
- readonly action: "unassigned";
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** Format: date-time */
+ readonly updated_at: string;
/** Format: uri */
- readonly url?: string;
+ readonly url: string;
+ readonly workflow_id: number;
+ readonly workflow_url?: string;
+ readonly display_title: string;
} | null;
+ };
+ readonly "webhook-deployment-review-requested": {
+ /** @enum {string} */
+ readonly action: "requested";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly environment: string;
readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly organization: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly requestor: components["schemas"]["webhooks_user"];
+ readonly reviewers: {
/** User */
- readonly assignee?: {
+ readonly reviewer?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47457,7 +40288,7 @@ export interface components {
/** Format: uri */
readonly html_url?: string;
readonly id: number;
- readonly login: string;
+ readonly login?: string;
readonly name?: string;
readonly node_id?: string;
/** Format: uri */
@@ -47472,11 +40303,29 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
- readonly assignees: ({
+ /** @enum {string} */
+ readonly type?: "User" | "Team";
+ }[];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ readonly since: string;
+ readonly workflow_job_run: {
+ readonly conclusion: unknown;
+ readonly created_at: string;
+ readonly environment: string;
+ readonly html_url: string;
+ readonly id: number;
+ readonly name: string | null;
+ readonly status: string;
+ readonly updated_at: string;
+ };
+ /** Deployment Workflow Run */
+ readonly workflow_run: {
+ /** User */
+ readonly actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47508,359 +40357,208 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
+ } | null;
+ readonly artifacts_url?: string;
+ readonly cancel_url?: string;
+ readonly check_suite_id: number;
+ readonly check_suite_node_id: string;
+ readonly check_suite_url?: string;
+ /** @enum {string|null} */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
/** Format: date-time */
readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
+ readonly event: string;
+ readonly head_branch: string;
+ readonly head_commit?: Record;
+ readonly head_repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
+ readonly type?: string;
readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
+ };
+ readonly head_sha: string;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly jobs_url?: string;
+ readonly logs_url?: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly path: string;
+ readonly previous_attempt_url?: string | null;
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
/** Format: uri */
readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
+ }[];
+ readonly referenced_workflows?: {
+ readonly path: string;
+ readonly ref?: string;
+ readonly sha: string;
+ }[] | null;
+ readonly repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
+ readonly type?: string;
+ readonly url?: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
readonly url?: string;
- } | null;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues unlabeled event */
- readonly "webhook-issues-unlabeled": {
- /** @enum {string} */
- readonly action: "unlabeled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ };
+ readonly rerun_url?: string;
+ readonly run_attempt: number;
+ readonly run_number: number;
+ /** Format: date-time */
+ readonly run_started_at: string;
+ /** @enum {string} */
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
/** User */
- readonly assignee?: {
+ readonly triggering_actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47892,11 +40590,61 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
} | null;
- readonly assignees: ({
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ readonly workflow_id: number;
+ readonly workflow_url?: string;
+ readonly display_title: string;
+ } | null;
+ };
+ /** deployment_status created event */
+ readonly "webhook-deployment-status-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly check_run?: {
+ /** Format: date-time */
+ readonly completed_at: string | null;
+ /**
+ * @description The result of the completed check run. This value will be `null` until the check run has completed.
+ * @enum {string|null}
+ */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null;
+ /** Format: uri */
+ readonly details_url: string;
+ readonly external_id: string;
+ /** @description The SHA of the commit that is being checked. */
+ readonly head_sha: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description The id of the check. */
+ readonly id: number;
+ /** @description The name of the check run. */
+ readonly name: string;
+ readonly node_id: string;
+ /** Format: date-time */
+ readonly started_at: string;
+ /**
+ * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`.
+ * @enum {string}
+ */
+ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "pending";
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ /**
+ * Deployment
+ * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).
+ */
+ readonly deployment: {
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -47928,123 +40676,16 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly type?: "Bot" | "User" | "Organization";
/** Format: uri */
readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
} | null;
+ readonly description: string | null;
+ readonly environment: string;
+ readonly id: number;
readonly node_id: string;
- readonly number: number;
+ readonly original_environment: string;
+ readonly payload: (string | Record) | null;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
@@ -48054,7 +40695,7 @@ export interface components {
readonly created_at: string | null;
readonly description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[];
/** Format: uri */
readonly external_url: string | null;
/** Format: uri */
@@ -48138,7 +40779,7 @@ export interface components {
/** @enum {string} */
readonly organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ readonly organization_projects?: "read" | "write";
/** @enum {string} */
readonly organization_secrets?: "read" | "write";
/** @enum {string} */
@@ -48150,333 +40791,99 @@ export interface components {
/** @enum {string} */
readonly pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
- };
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- /** Label */
- readonly label?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues unlocked event */
- readonly "webhook-issues-unlocked": {
- /** @enum {string} */
- readonly action: "unlocked";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- /** User */
- readonly assignee?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
+ readonly pull_requests?: "read" | "write";
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
/** Format: date-time */
- readonly due_on: string | null;
+ readonly updated_at: string | null;
+ } | null;
+ readonly production_environment?: boolean;
+ readonly ref: string;
+ /** Format: uri */
+ readonly repository_url: string;
+ readonly sha: string;
+ /** Format: uri */
+ readonly statuses_url: string;
+ readonly task: string;
+ readonly transient_environment?: boolean;
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */
+ readonly deployment_status: {
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
/** Format: uri */
- readonly html_url: string;
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
+ readonly organizations_url?: string;
/** Format: uri */
- readonly url: string;
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
} | null;
+ /** Format: uri */
+ readonly deployment_url: string;
+ /** @description The optional human-readable description added to the status. */
+ readonly description: string;
+ readonly environment: string;
+ /** Format: uri */
+ readonly environment_url?: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly log_url?: string;
readonly node_id: string;
- readonly number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
@@ -48486,7 +40893,7 @@ export interface components {
readonly created_at: string | null;
readonly description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[];
/** Format: uri */
readonly external_url: string | null;
/** Format: uri */
@@ -48611,167 +41018,26 @@ export interface components {
/** Format: date-time */
readonly updated_at: string | null;
} | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
- readonly url?: string;
- };
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
/** Format: uri */
readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
- /** Format: date-time */
+ /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */
+ readonly state: string;
+ /** @description The optional link added to the status. */
+ readonly target_url: string;
readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
+ /** Format: uri */
readonly url: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- } & {
- readonly active_lock_reason: unknown;
- readonly assignee?: Record;
- readonly assignees?: Record[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels?: Record[];
- readonly labels_url?: string;
- /** @enum {boolean} */
- readonly locked: false;
- readonly milestone?: Record;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: unknown;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- readonly state?: string;
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
};
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** issues unpinned event */
- readonly "webhook-issues-unpinned": {
- /** @enum {string} */
- readonly action: "unpinned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
- /** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ readonly workflow?: components["schemas"]["webhooks_workflow"];
+ /** Deployment Workflow Run */
+ readonly workflow_run?: {
/** User */
- readonly assignee?: {
+ readonly actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -48807,336 +41073,205 @@ export interface components {
/** Format: uri */
readonly url?: string;
} | null;
- readonly assignees: ({
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
+ readonly artifacts_url?: string;
+ readonly cancel_url?: string;
+ readonly check_suite_id: number;
+ readonly check_suite_node_id: string;
+ readonly check_suite_url?: string;
+ /** @enum {string|null} */
+ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure";
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly display_title: string;
+ readonly event: string;
+ readonly head_branch: string;
+ readonly head_commit?: unknown;
+ readonly head_repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: unknown;
+ readonly downloads_url?: string;
readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
readonly name?: string;
readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null)[];
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- /** @description Contents of the issue */
- readonly body: string | null;
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
- /** Format: uri */
- readonly comments_url: string;
- /** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
- /** Format: uri */
- readonly events_url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: int64 */
- readonly id: number;
- readonly labels?: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- }[];
- /** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
+ readonly type?: string;
readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
+ };
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
+ readonly url?: string;
+ };
+ readonly head_sha: string;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ readonly jobs_url?: string;
+ readonly logs_url?: string;
+ readonly name: string;
+ readonly node_id: string;
+ readonly path: string;
+ readonly previous_attempt_url?: unknown;
+ readonly pull_requests: {
+ readonly base: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
+ readonly head: {
+ readonly ref: string;
+ /** Repo Ref */
+ readonly repo: {
+ readonly id: number;
+ readonly name: string;
+ /** Format: uri */
+ readonly url: string;
+ };
+ readonly sha: string;
+ };
readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
/** Format: uri */
readonly url: string;
- } | null;
- readonly node_id: string;
- readonly number: number;
- /**
- * App
- * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- */
- readonly performed_via_github_app?: {
- /** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
- /** @description The list of events for the GitHub app */
- readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
- /** Format: uri */
- readonly external_url: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the GitHub app */
- readonly id: number | null;
- /** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
- /** User */
- readonly owner: {
- /** Format: uri */
+ }[];
+ readonly referenced_workflows?: {
+ readonly path: string;
+ readonly ref?: string;
+ readonly sha: string;
+ }[] | null;
+ readonly repository?: {
+ readonly archive_url?: string;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly deployments_url?: string;
+ readonly description?: unknown;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ readonly fork?: boolean;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly languages_url?: string;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly owner?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
+ readonly type?: string;
readonly url?: string;
- } | null;
- /** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
- /** @enum {string} */
- readonly administration?: "read" | "write";
- /** @enum {string} */
- readonly checks?: "read" | "write";
- /** @enum {string} */
- readonly content_references?: "read" | "write";
- /** @enum {string} */
- readonly contents?: "read" | "write";
- /** @enum {string} */
- readonly deployments?: "read" | "write";
- /** @enum {string} */
- readonly discussions?: "read" | "write";
- /** @enum {string} */
- readonly emails?: "read" | "write";
- /** @enum {string} */
- readonly environments?: "read" | "write";
- /** @enum {string} */
- readonly issues?: "read" | "write";
- /** @enum {string} */
- readonly keys?: "read" | "write";
- /** @enum {string} */
- readonly members?: "read" | "write";
- /** @enum {string} */
- readonly metadata?: "read" | "write";
- /** @enum {string} */
- readonly organization_administration?: "read" | "write";
- /** @enum {string} */
- readonly organization_hooks?: "read" | "write";
- /** @enum {string} */
- readonly organization_packages?: "read" | "write";
- /** @enum {string} */
- readonly organization_plan?: "read" | "write";
- /** @enum {string} */
- readonly organization_projects?: "read" | "write";
- /** @enum {string} */
- readonly organization_secrets?: "read" | "write";
- /** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
- /** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
- /** @enum {string} */
- readonly packages?: "read" | "write";
- /** @enum {string} */
- readonly pages?: "read" | "write";
- /** @enum {string} */
- readonly pull_requests?: "read" | "write";
- /** @enum {string} */
- readonly repository_hooks?: "read" | "write";
- /** @enum {string} */
- readonly repository_projects?: "read" | "write";
- /** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
- /** @enum {string} */
- readonly secrets?: "read" | "write";
- /** @enum {string} */
- readonly security_events?: "read" | "write";
- /** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
- /** @enum {string} */
- readonly single_file?: "read" | "write";
- /** @enum {string} */
- readonly statuses?: "read" | "write";
- /** @enum {string} */
- readonly team_discussions?: "read" | "write";
- /** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
};
- /** @description The slug name of the GitHub app */
- readonly slug?: string;
- /** Format: date-time */
- readonly updated_at: string | null;
- } | null;
- readonly pull_request?: {
- /** Format: uri */
- readonly diff_url?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: date-time */
- readonly merged_at?: string | null;
- /** Format: uri */
- readonly patch_url?: string;
- /** Format: uri */
+ readonly private?: boolean;
+ readonly pulls_url?: string;
+ readonly releases_url?: string;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly trees_url?: string;
readonly url?: string;
};
- /** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /**
- * @description State of the issue; either 'open' or 'closed'
- * @enum {string}
- */
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
- /** Format: uri */
- readonly timeline_url?: string;
- /** @description Title of the issue */
- readonly title: string;
+ readonly rerun_url?: string;
+ readonly run_attempt: number;
+ readonly run_number: number;
/** Format: date-time */
- readonly updated_at: string;
- /**
- * Format: uri
- * @description URL for the issue
- */
- readonly url: string;
+ readonly run_started_at: string;
+ /** @enum {string} */
+ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
/** User */
- readonly user: {
+ readonly triggering_actor: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -49172,1055 +41307,930 @@ export interface components {
/** Format: uri */
readonly url?: string;
} | null;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ readonly workflow_id: number;
+ readonly workflow_url?: string;
+ } | null;
+ };
+ /** discussion answered event */
+ readonly "webhook-discussion-answered": {
+ /** @enum {string} */
+ readonly action: "answered";
+ readonly answer: components["schemas"]["webhooks_answer"];
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion category changed event */
+ readonly "webhook-discussion-category-changed": {
+ /** @enum {string} */
+ readonly action: "category_changed";
+ readonly changes: {
+ readonly category: {
+ readonly from: {
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly description: string;
+ readonly emoji: string;
+ readonly id: number;
+ readonly is_answerable: boolean;
+ readonly name: string;
+ readonly node_id?: string;
+ readonly repository_id: number;
+ readonly slug: string;
+ readonly updated_at: string;
+ };
+ };
};
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** label created event */
- readonly "webhook-label-created": {
+ /** discussion closed event */
+ readonly "webhook-discussion-closed": {
+ /** @enum {string} */
+ readonly action: "closed";
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion_comment created event */
+ readonly "webhook-discussion-comment-created": {
/** @enum {string} */
readonly action: "created";
+ readonly comment: components["schemas"]["webhooks_comment"];
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** Label */
- readonly label: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** label deleted event */
- readonly "webhook-label-deleted": {
+ /** discussion_comment deleted event */
+ readonly "webhook-discussion-comment-deleted": {
/** @enum {string} */
readonly action: "deleted";
+ readonly comment: components["schemas"]["webhooks_comment"];
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** Label */
- readonly label: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** label edited event */
- readonly "webhook-label-edited": {
+ /** discussion_comment edited event */
+ readonly "webhook-discussion-comment-edited": {
/** @enum {string} */
readonly action: "edited";
- /** @description The changes to the label if the action was `edited`. */
- readonly changes?: {
- readonly color?: {
- /** @description The previous version of the color if the action was `edited`. */
+ readonly changes: {
+ readonly body: {
readonly from: string;
};
- readonly description?: {
- /** @description The previous version of the description if the action was `edited`. */
+ };
+ readonly comment: components["schemas"]["webhooks_comment"];
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion created event */
+ readonly "webhook-discussion-created": {
+ /** @enum {string} */
+ readonly action: "created";
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion deleted event */
+ readonly "webhook-discussion-deleted": {
+ /** @enum {string} */
+ readonly action: "deleted";
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion edited event */
+ readonly "webhook-discussion-edited": {
+ /** @enum {string} */
+ readonly action: "edited";
+ readonly changes?: {
+ readonly body?: {
readonly from: string;
};
- readonly name?: {
- /** @description The previous version of the name if the action was `edited`. */
+ readonly title?: {
readonly from: string;
};
};
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** Label */
- readonly label: {
- /** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
- /** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- */
- readonly url: string;
- };
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** marketplace_purchase cancelled event */
- readonly "webhook-marketplace-purchase-cancelled": {
+ /** discussion labeled event */
+ readonly "webhook-discussion-labeled": {
/** @enum {string} */
- readonly action: "cancelled";
- readonly effective_date: string;
+ readonly action: "labeled";
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- } & {
- readonly account?: {
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organization_billing_email?: string | null;
- readonly type?: string;
- };
- readonly billing_cycle?: string;
- readonly free_trial_ends_on?: string | null;
- readonly next_billing_date: string | null;
- readonly on_free_trial?: boolean;
- readonly plan?: {
- readonly bullets?: (string | null)[];
- readonly description?: string;
- readonly has_free_trial?: boolean;
- readonly id?: number;
- readonly monthly_price_in_cents?: number;
- readonly name?: string;
- /** @enum {string} */
- readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name?: string | null;
- readonly yearly_price_in_cents?: number;
- };
- readonly unit_count?: number;
- };
+ readonly label: components["schemas"]["webhooks_label"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Marketplace Purchase */
- readonly previous_marketplace_purchase?: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: unknown;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** marketplace_purchase changed event */
- readonly "webhook-marketplace-purchase-changed": {
+ /** discussion locked event */
+ readonly "webhook-discussion-locked": {
/** @enum {string} */
- readonly action: "changed";
- readonly effective_date: string;
+ readonly action: "locked";
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- } & {
- readonly account?: {
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organization_billing_email?: string | null;
- readonly type?: string;
- };
- readonly billing_cycle?: string;
- readonly free_trial_ends_on?: string | null;
- readonly next_billing_date: string | null;
- readonly on_free_trial?: boolean;
- readonly plan?: {
- readonly bullets?: (string | null)[];
- readonly description?: string;
- readonly has_free_trial?: boolean;
- readonly id?: number;
- readonly monthly_price_in_cents?: number;
- readonly name?: string;
- /** @enum {string} */
- readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name?: string | null;
- readonly yearly_price_in_cents?: number;
- };
- readonly unit_count?: number;
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion pinned event */
+ readonly "webhook-discussion-pinned": {
+ /** @enum {string} */
+ readonly action: "pinned";
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion reopened event */
+ readonly "webhook-discussion-reopened": {
+ /** @enum {string} */
+ readonly action: "reopened";
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion transferred event */
+ readonly "webhook-discussion-transferred": {
+ /** @enum {string} */
+ readonly action: "transferred";
+ readonly changes: {
+ readonly new_discussion: components["schemas"]["discussion"];
+ readonly new_repository: components["schemas"]["repository-webhooks"];
};
+ readonly discussion: components["schemas"]["discussion"];
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Marketplace Purchase */
- readonly previous_marketplace_purchase?: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean | null;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** marketplace_purchase pending_change event */
- readonly "webhook-marketplace-purchase-pending-change": {
+ /** discussion unanswered event */
+ readonly "webhook-discussion-unanswered": {
/** @enum {string} */
- readonly action: "pending_change";
- readonly effective_date: string;
+ readonly action: "unanswered";
+ readonly discussion: components["schemas"]["discussion"];
+ readonly old_answer: components["schemas"]["webhooks_answer"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion unlabeled event */
+ readonly "webhook-discussion-unlabeled": {
+ /** @enum {string} */
+ readonly action: "unlabeled";
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- } & {
- readonly account?: {
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organization_billing_email?: string | null;
- readonly type?: string;
- };
- readonly billing_cycle?: string;
- readonly free_trial_ends_on?: string | null;
- readonly next_billing_date: string | null;
- readonly on_free_trial?: boolean;
- readonly plan?: {
- readonly bullets?: (string | null)[];
- readonly description?: string;
- readonly has_free_trial?: boolean;
- readonly id?: number;
- readonly monthly_price_in_cents?: number;
- readonly name?: string;
- /** @enum {string} */
- readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name?: string | null;
- readonly yearly_price_in_cents?: number;
- };
- readonly unit_count?: number;
- };
+ readonly label: components["schemas"]["webhooks_label"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Marketplace Purchase */
- readonly previous_marketplace_purchase?: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** marketplace_purchase pending_change_cancelled event */
- readonly "webhook-marketplace-purchase-pending-change-cancelled": {
+ /** discussion unlocked event */
+ readonly "webhook-discussion-unlocked": {
/** @enum {string} */
- readonly action: "pending_change_cancelled";
- readonly effective_date: string;
+ readonly action: "unlocked";
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: unknown;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- } & {
- readonly next_billing_date: string;
- };
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Marketplace Purchase */
- readonly previous_marketplace_purchase?: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: unknown;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** marketplace_purchase purchased event */
- readonly "webhook-marketplace-purchase-purchased": {
+ /** discussion unpinned event */
+ readonly "webhook-discussion-unpinned": {
/** @enum {string} */
- readonly action: "purchased";
- readonly effective_date: string;
+ readonly action: "unpinned";
+ readonly discussion: components["schemas"]["discussion"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * fork event
+ * @description A user forks a repository.
+ */
+ readonly "webhook-fork": {
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */
+ readonly forkee: {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ readonly allow_auto_merge: boolean;
+ /** @description Whether to allow private forks */
+ readonly allow_forking?: boolean;
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ readonly allow_merge_commit: boolean;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ readonly allow_rebase_merge: boolean;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ readonly allow_squash_merge: boolean;
+ readonly allow_update_branch?: boolean;
+ /** Format: uri-template */
+ readonly archive_url: string;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ readonly archived: boolean;
+ /** Format: uri-template */
+ readonly assignees_url: string;
+ /** Format: uri-template */
+ readonly blobs_url: string;
+ /** Format: uri-template */
+ readonly branches_url: string;
+ /** Format: uri */
+ readonly clone_url: string;
+ /** Format: uri-template */
+ readonly collaborators_url: string;
+ /** Format: uri-template */
+ readonly comments_url: string;
+ /** Format: uri-template */
+ readonly commits_url: string;
+ /** Format: uri-template */
+ readonly compare_url: string;
+ /** Format: uri-template */
+ readonly contents_url: string;
+ /** Format: uri */
+ readonly contributors_url: string;
+ readonly created_at: number | string;
+ /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
+ readonly custom_properties?: {
+ readonly [key: string]: unknown;
};
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
+ /** @description The default branch of the repository. */
+ readonly default_branch: string;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ readonly delete_branch_on_merge: boolean;
+ /** Format: uri */
+ readonly deployments_url: string;
+ readonly description: string | null;
+ /** @description Returns whether or not this repository is disabled. */
+ readonly disabled?: boolean;
+ /** Format: uri */
+ readonly downloads_url: string;
+ /** Format: uri */
+ readonly events_url: string;
+ readonly fork: boolean;
+ readonly forks: number;
+ readonly forks_count: number;
+ /** Format: uri */
+ readonly forks_url: string;
+ readonly full_name: string;
+ /** Format: uri-template */
+ readonly git_commits_url: string;
+ /** Format: uri-template */
+ readonly git_refs_url: string;
+ /** Format: uri-template */
+ readonly git_tags_url: string;
+ /** Format: uri */
+ readonly git_url: string;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ */
+ readonly has_downloads: boolean;
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ readonly has_issues: boolean;
+ readonly has_pages: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ readonly has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ readonly has_wiki: boolean;
+ readonly homepage: string | null;
+ /** Format: uri */
+ readonly hooks_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the repository */
+ readonly id: number;
+ readonly is_template?: boolean;
+ /** Format: uri-template */
+ readonly issue_comment_url: string;
+ /** Format: uri-template */
+ readonly issue_events_url: string;
+ /** Format: uri-template */
+ readonly issues_url: string;
+ /** Format: uri-template */
+ readonly keys_url: string;
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly language: string | null;
+ /** Format: uri */
+ readonly languages_url: string;
+ /** License */
+ readonly license: {
+ readonly key: string;
readonly name: string;
+ readonly node_id: string;
+ readonly spdx_id: string;
+ /** Format: uri */
+ readonly url: string | null;
+ } | null;
+ readonly master_branch?: string;
+ /** Format: uri */
+ readonly merges_url: string;
+ /** Format: uri-template */
+ readonly milestones_url: string;
+ /** Format: uri */
+ readonly mirror_url: string | null;
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** Format: uri-template */
+ readonly notifications_url: string;
+ readonly open_issues: number;
+ readonly open_issues_count: number;
+ readonly organization?: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
/** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly permissions?: {
+ readonly admin: boolean;
+ readonly maintain?: boolean;
+ readonly pull: boolean;
+ readonly push: boolean;
+ readonly triage?: boolean;
};
- readonly unit_count: number;
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ readonly public?: boolean;
+ /** Format: uri-template */
+ readonly pulls_url: string;
+ readonly pushed_at: (number | string) | null;
+ /** Format: uri-template */
+ readonly releases_url: string;
+ readonly role_name?: string | null;
+ readonly size: number;
+ readonly ssh_url: string;
+ readonly stargazers?: number;
+ readonly stargazers_count: number;
+ /** Format: uri */
+ readonly stargazers_url: string;
+ /** Format: uri-template */
+ readonly statuses_url: string;
+ /** Format: uri */
+ readonly subscribers_url: string;
+ /** Format: uri */
+ readonly subscription_url: string;
+ /** Format: uri */
+ readonly svn_url: string;
+ /** Format: uri */
+ readonly tags_url: string;
+ /** Format: uri */
+ readonly teams_url: string;
+ readonly topics: string[];
+ /** Format: uri-template */
+ readonly trees_url: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ /** @enum {string} */
+ readonly visibility: "public" | "private" | "internal";
+ readonly watchers: number;
+ readonly watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ readonly web_commit_signoff_required?: boolean;
} & {
- readonly account?: {
+ readonly allow_forking?: boolean;
+ readonly archive_url?: string;
+ readonly archived?: boolean;
+ readonly assignees_url?: string;
+ readonly blobs_url?: string;
+ readonly branches_url?: string;
+ readonly clone_url?: string;
+ readonly collaborators_url?: string;
+ readonly comments_url?: string;
+ readonly commits_url?: string;
+ readonly compare_url?: string;
+ readonly contents_url?: string;
+ readonly contributors_url?: string;
+ readonly created_at?: string;
+ readonly default_branch?: string;
+ readonly deployments_url?: string;
+ readonly description?: string | null;
+ readonly disabled?: boolean;
+ readonly downloads_url?: string;
+ readonly events_url?: string;
+ /** @enum {boolean} */
+ readonly fork?: true;
+ readonly forks?: number;
+ readonly forks_count?: number;
+ readonly forks_url?: string;
+ readonly full_name?: string;
+ readonly git_commits_url?: string;
+ readonly git_refs_url?: string;
+ readonly git_tags_url?: string;
+ readonly git_url?: string;
+ readonly has_downloads?: boolean;
+ readonly has_issues?: boolean;
+ readonly has_pages?: boolean;
+ readonly has_projects?: boolean;
+ readonly has_wiki?: boolean;
+ readonly homepage?: string | null;
+ readonly hooks_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly is_template?: boolean;
+ readonly issue_comment_url?: string;
+ readonly issue_events_url?: string;
+ readonly issues_url?: string;
+ readonly keys_url?: string;
+ readonly labels_url?: string;
+ readonly language?: unknown;
+ readonly languages_url?: string;
+ readonly license?: Record;
+ readonly merges_url?: string;
+ readonly milestones_url?: string;
+ readonly mirror_url?: unknown;
+ readonly name?: string;
+ readonly node_id?: string;
+ readonly notifications_url?: string;
+ readonly open_issues?: number;
+ readonly open_issues_count?: number;
+ readonly owner?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
readonly id?: number;
readonly login?: string;
readonly node_id?: string;
- readonly organization_billing_email?: string | null;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
readonly type?: string;
+ readonly url?: string;
};
- readonly billing_cycle?: string;
- readonly free_trial_ends_on?: string | null;
- readonly next_billing_date: string | null;
- readonly on_free_trial?: boolean;
- readonly plan?: {
- readonly bullets?: (string | null)[];
- readonly description?: string;
- readonly has_free_trial?: boolean;
- readonly id?: number;
- readonly monthly_price_in_cents?: number;
- readonly name?: string;
- /** @enum {string} */
- readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name?: string | null;
- readonly yearly_price_in_cents?: number;
- };
- readonly unit_count?: number;
+ readonly private?: boolean;
+ readonly public?: boolean;
+ readonly pulls_url?: string;
+ readonly pushed_at?: string;
+ readonly releases_url?: string;
+ readonly size?: number;
+ readonly ssh_url?: string;
+ readonly stargazers_count?: number;
+ readonly stargazers_url?: string;
+ readonly statuses_url?: string;
+ readonly subscribers_url?: string;
+ readonly subscription_url?: string;
+ readonly svn_url?: string;
+ readonly tags_url?: string;
+ readonly teams_url?: string;
+ readonly topics?: unknown[];
+ readonly trees_url?: string;
+ readonly updated_at?: string;
+ readonly url?: string;
+ readonly visibility?: string;
+ readonly watchers?: number;
+ readonly watchers_count?: number;
};
+ readonly installation?: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** Marketplace Purchase */
- readonly previous_marketplace_purchase?: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: unknown;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
- /** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
- };
- readonly unit_count: number;
- };
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** member added event */
- readonly "webhook-member-added": {
+ /** github_app_authorization revoked event */
+ readonly "webhook-github-app-authorization-revoked": {
/** @enum {string} */
- readonly action: "added";
- readonly changes?: {
- readonly permission?: {
- /** @enum {string} */
- readonly to: "write" | "admin" | "read";
- };
- };
+ readonly action: "revoked";
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** gollum event */
+ readonly "webhook-gollum": {
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /** User */
- readonly member: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description The pages that were updated. */
+ readonly pages: {
+ /**
+ * @description The action that was performed on the page. Can be `created` or `edited`.
+ * @enum {string}
+ */
+ readonly action: "created" | "edited";
+ /**
+ * Format: uri
+ * @description Points to the HTML wiki page.
+ */
+ readonly html_url: string;
+ /** @description The name of the page. */
+ readonly page_name: string;
+ /** @description The latest commit SHA of the page. */
+ readonly sha: string;
+ readonly summary: string | null;
+ /** @description The current page title. */
+ readonly title: string;
+ }[];
readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** member edited event */
- readonly "webhook-member-edited": {
+ /** installation created event */
+ readonly "webhook-installation-created": {
/** @enum {string} */
- readonly action: "edited";
- /** @description The changes to the collaborator permissions */
- readonly changes: {
- readonly old_permission?: {
- /** @description The previous permissions of the collaborator if the action was edited. */
- readonly from: string;
- };
- readonly permission?: {
- readonly from?: string | null;
- readonly to?: string | null;
- };
- };
+ readonly action: "created";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** User */
- readonly member: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
+ readonly installation: components["schemas"]["installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
+ readonly repositories?: components["schemas"]["webhooks_repositories"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly requester?: components["schemas"]["webhooks_user"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** member removed event */
- readonly "webhook-member-removed": {
+ /** installation deleted event */
+ readonly "webhook-installation-deleted": {
/** @enum {string} */
- readonly action: "removed";
+ readonly action: "deleted";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** User */
- readonly member: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
+ readonly installation: components["schemas"]["installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
+ readonly repositories?: components["schemas"]["webhooks_repositories"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly requester?: unknown;
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** membership added event */
- readonly "webhook-membership-added": {
+ /** installation new_permissions_accepted event */
+ readonly "webhook-installation-new-permissions-accepted": {
+ /** @enum {string} */
+ readonly action: "new_permissions_accepted";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation: components["schemas"]["installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repositories?: components["schemas"]["webhooks_repositories"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly requester?: unknown;
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** installation_repositories added event */
+ readonly "webhook-installation-repositories-added": {
/** @enum {string} */
readonly action: "added";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** User */
- readonly member: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
+ readonly installation: components["schemas"]["installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repositories_added: components["schemas"]["webhooks_repositories_added"];
+ /** @description An array of repository objects, which were removed from the installation. */
+ readonly repositories_removed: {
+ readonly full_name?: string;
+ /** @description Unique identifier of the repository */
+ readonly id?: number;
+ /** @description The name of the repository. */
readonly name?: string;
readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly organization: components["schemas"]["organization-simple-webhooks"];
+ /** @description Whether the repository is private or public. */
+ readonly private?: boolean;
+ }[];
readonly repository?: components["schemas"]["repository-webhooks"];
- /**
- * @description The scope of the membership. Currently, can only be `team`.
- * @enum {string}
- */
- readonly scope: "team";
- /** User */
- readonly sender: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly team: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /** @enum {string} */
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url?: string;
- };
+ readonly repository_selection: components["schemas"]["webhooks_repository_selection"];
+ readonly requester: components["schemas"]["webhooks_user"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** membership removed event */
- readonly "webhook-membership-removed": {
+ /** installation_repositories removed event */
+ readonly "webhook-installation-repositories-removed": {
/** @enum {string} */
readonly action: "removed";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** User */
- readonly member: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
+ readonly installation: components["schemas"]["installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repositories_added: components["schemas"]["webhooks_repositories_added"];
+ /** @description An array of repository objects, which were removed from the installation. */
+ readonly repositories_removed: {
+ readonly full_name: string;
+ /** @description Unique identifier of the repository */
readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly organization: components["schemas"]["organization-simple-webhooks"];
+ /** @description The name of the repository. */
+ readonly name: string;
+ readonly node_id: string;
+ /** @description Whether the repository is private or public. */
+ readonly private: boolean;
+ }[];
readonly repository?: components["schemas"]["repository-webhooks"];
- /**
- * @description The scope of the membership. Currently, can only be `team`.
- * @enum {string}
- */
- readonly scope: "team" | "organization";
- /** User */
- readonly sender: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
+ readonly repository_selection: components["schemas"]["webhooks_repository_selection"];
+ readonly requester: components["schemas"]["webhooks_user"];
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** installation suspend event */
+ readonly "webhook-installation-suspend": {
+ /** @enum {string} */
+ readonly action: "suspend";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation: components["schemas"]["installation"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repositories?: components["schemas"]["webhooks_repositories"];
+ readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly requester?: unknown;
+ readonly sender: components["schemas"]["simple-user-webhooks"];
+ };
+ readonly "webhook-installation-target-renamed": {
+ readonly account: {
+ readonly archived_at?: string | null;
+ readonly avatar_url: string;
+ readonly created_at?: string;
+ readonly description?: unknown;
readonly events_url?: string;
- /** Format: uri */
+ readonly followers?: number;
readonly followers_url?: string;
- /** Format: uri-template */
+ readonly following?: number;
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
+ readonly has_organization_projects?: boolean;
+ readonly has_repository_projects?: boolean;
+ readonly hooks_url?: string;
+ readonly html_url: string;
readonly id: number;
- readonly login: string;
+ readonly is_verified?: boolean;
+ readonly issues_url?: string;
+ readonly login?: string;
+ readonly members_url?: string;
readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
+ readonly node_id: string;
readonly organizations_url?: string;
- /** Format: uri */
+ readonly public_gists?: number;
+ readonly public_members_url?: string;
+ readonly public_repos?: number;
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
+ readonly slug?: string;
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- /**
- * Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- readonly team: {
- readonly deleted?: boolean;
- /** @description Description of the team */
- readonly description?: string | null;
- /** Format: uri */
- readonly html_url?: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url?: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
- /** @description Description of the team */
- readonly description: string | null;
- /** Format: uri */
- readonly html_url: string;
- /** @description Unique identifier of the team */
- readonly id: number;
- /** Format: uri-template */
- readonly members_url: string;
- /** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- /** @description Permission that the team will have for its repositories */
- readonly permission: string;
- /** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
- /**
- * @description Whether team members will receive notifications when their team is @mentioned
- * @enum {string}
- */
- readonly notification_setting: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
- /**
- * Format: uri
- * @description URL for the team
- */
- readonly url: string;
- } | null;
- /** @description Permission that the team will have for its repositories */
- readonly permission?: string;
- /** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
- /** @enum {string} */
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
- /**
- * Format: uri
- * @description URL for the team
- */
+ readonly type?: string;
+ readonly updated_at?: string;
readonly url?: string;
+ readonly website_url?: unknown;
};
- };
- readonly "webhook-merge-group-checks-requested": {
/** @enum {string} */
- readonly action: "checks_requested";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly merge_group: components["schemas"]["merge-group"];
+ readonly action: "renamed";
+ readonly changes: {
+ readonly login?: {
+ readonly from: string;
+ };
+ readonly slug?: {
+ readonly from: string;
+ };
+ };
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation: components["schemas"]["simple-installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
readonly repository?: components["schemas"]["repository-webhooks"];
readonly sender?: components["schemas"]["simple-user-webhooks"];
+ readonly target_type: string;
};
- readonly "webhook-merge-group-destroyed": {
+ /** installation unsuspend event */
+ readonly "webhook-installation-unsuspend": {
/** @enum {string} */
- readonly action: "destroyed";
- /**
- * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated).
- * @enum {string}
- */
- readonly reason?: "merged" | "invalidated" | "dequeued";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly merge_group: components["schemas"]["merge-group"];
+ readonly action: "unsuspend";
+ readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ readonly installation: components["schemas"]["installation"];
readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repositories?: components["schemas"]["webhooks_repositories"];
readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
+ readonly requester?: unknown;
+ readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** meta deleted event */
- readonly "webhook-meta-deleted": {
+ /** issue_comment created event */
+ readonly "webhook-issue-comment-created": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */
- readonly hook: {
- readonly active: boolean;
- readonly config: {
- /** @enum {string} */
- readonly content_type: "json" | "form";
- readonly insecure_ssl: string;
- readonly secret?: string;
+ readonly action: "created";
+ /**
+ * issue comment
+ * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
+ */
+ readonly comment: {
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue comment */
+ readonly body: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /**
+ * Format: int64
+ * @description Unique identifier of the issue comment
+ */
+ readonly id: number;
+ /** Format: uri */
+ readonly issue_url: string;
+ readonly node_id: string;
+ readonly performed_via_github_app: components["schemas"]["nullable-integration"];
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
/** Format: uri */
readonly url: string;
};
- readonly created_at: string;
- readonly events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[];
- readonly id: number;
- readonly name: string;
- readonly type: string;
+ /** Format: date-time */
readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue comment
+ */
+ readonly url: string;
+ /** User */
+ readonly user: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
};
- /** @description The id of the modified webhook. */
- readonly hook_id: number;
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["nullable-repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user-webhooks"];
- };
- /** milestone closed event */
- readonly "webhook-milestone-closed": {
- /** @enum {string} */
- readonly action: "closed";
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly creator: {
+ readonly assignee?: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly assignees: ({
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50228,161 +42238,328 @@ export interface components {
/** Format: uri-template */
readonly events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ readonly node_id: string;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
/** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
/** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ readonly patch_url?: string;
/** Format: uri */
readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ readonly repository_url: string;
/**
- * @description The state of the milestone.
+ * @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
readonly title: string;
/** Format: date-time */
readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** milestone created event */
- readonly "webhook-milestone-created": {
- /** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
/**
- * @description The state of the milestone.
- * @enum {string}
+ * Format: uri
+ * @description URL for the issue
*/
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** milestone deleted event */
- readonly "webhook-milestone-deleted": {
- /** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
/** User */
- readonly creator: {
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50418,67 +42595,10 @@ export interface components {
/** Format: uri */
readonly url?: string;
} | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** milestone edited event */
- readonly "webhook-milestone-edited": {
- /** @enum {string} */
- readonly action: "edited";
- /** @description The changes to the milestone if the action was `edited`. */
- readonly changes: {
- readonly description?: {
- /** @description The previous version of the description if the action was `edited`. */
- readonly from: string;
- };
- readonly due_on?: {
- /** @description The previous version of the due date if the action was `edited`. */
- readonly from: string;
- };
- readonly title?: {
- /** @description The previous version of the title if the action was `edited`. */
- readonly from: string;
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
+ } & {
+ readonly active_lock_reason?: string | null;
/** User */
- readonly creator: {
+ readonly assignee: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50514,228 +42634,97 @@ export interface components {
/** Format: uri */
readonly url?: string;
} | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ readonly assignees?: Record[];
+ readonly author_association?: string;
+ readonly body?: string | null;
+ readonly closed_at?: string | null;
+ readonly comments?: number;
+ readonly comments_url?: string;
+ readonly created_at?: string;
+ readonly events_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ readonly labels_url?: string;
+ readonly locked: boolean;
+ readonly milestone?: Record;
+ readonly node_id?: string;
+ readonly number?: number;
+ readonly performed_via_github_app?: Record;
+ readonly reactions?: {
+ readonly "+1"?: number;
+ readonly "-1"?: number;
+ readonly confused?: number;
+ readonly eyes?: number;
+ readonly heart?: number;
+ readonly hooray?: number;
+ readonly laugh?: number;
+ readonly rocket?: number;
+ readonly total_count?: number;
+ readonly url?: string;
+ };
+ readonly repository_url?: string;
/**
- * @description The state of the milestone.
+ * @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** milestone opened event */
- readonly "webhook-milestone-opened": {
- /** @enum {string} */
- readonly action: "opened";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Milestone
- * @description A collection of related issues and pull requests.
- */
- readonly milestone: {
- /** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
- /** Format: date-time */
- readonly created_at: string;
- /** User */
- readonly creator: {
- /** Format: uri */
+ readonly timeline_url?: string;
+ readonly title?: string;
+ readonly updated_at?: string;
+ readonly url?: string;
+ readonly user?: {
readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
readonly events_url?: string;
- /** Format: uri */
readonly followers_url?: string;
- /** Format: uri-template */
readonly following_url?: string;
- /** Format: uri-template */
readonly gists_url?: string;
readonly gravatar_id?: string;
- /** Format: uri */
readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
+ readonly id?: number;
+ readonly login?: string;
readonly node_id?: string;
- /** Format: uri */
readonly organizations_url?: string;
- /** Format: uri */
readonly received_events_url?: string;
- /** Format: uri */
readonly repos_url?: string;
readonly site_admin?: boolean;
- /** Format: uri-template */
readonly starred_url?: string;
- /** Format: uri */
readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly description: string | null;
- /** Format: date-time */
- readonly due_on: string | null;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- /** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
- /** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
- /**
- * @description The state of the milestone.
- * @enum {string}
- */
- readonly state: "open" | "closed";
- /** @description The title of the milestone. */
- readonly title: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** org_block blocked event */
- readonly "webhook-org-block-blocked": {
- /** @enum {string} */
- readonly action: "blocked";
- /** User */
- readonly blocked_user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** org_block unblocked event */
- readonly "webhook-org-block-unblocked": {
- /** @enum {string} */
- readonly action: "unblocked";
- /** User */
- readonly blocked_user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly type?: string;
+ readonly url?: string;
+ };
+ };
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** organization deleted event */
- readonly "webhook-organization-deleted": {
+ /** issue_comment deleted event */
+ readonly "webhook-issue-comment-deleted": {
/** @enum {string} */
readonly action: "deleted";
+ readonly comment: components["schemas"]["webhooks_issue_comment"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Membership
- * @description The membership between the user and the organization. Not present when the action is `member_invited`.
- */
- readonly membership?: {
- /** Format: uri */
- readonly organization_url: string;
- readonly role: string;
- readonly state: string;
- /** Format: uri */
- readonly url: string;
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly user: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50767,34 +42756,11 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- };
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** organization member_added event */
- readonly "webhook-organization-member-added": {
- /** @enum {string} */
- readonly action: "member_added";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Membership
- * @description The membership between the user and the organization. Not present when the action is `member_invited`.
- */
- readonly membership: {
- /** Format: uri */
- readonly organization_url: string;
- readonly role: string;
- readonly state: string;
- /** Format: uri */
- readonly url: string;
- /** User */
- readonly user: {
+ readonly assignees: ({
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50826,34 +42792,304 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
- } | null;
- };
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** organization member_invited event */
- readonly "webhook-organization-member-invited": {
- /** @enum {string} */
- readonly action: "member_invited";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The invitation for the user or email if the action is `member_invited`. */
- readonly invitation: {
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
/** Format: date-time */
- readonly created_at: string;
- readonly email: string | null;
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
/** Format: date-time */
- readonly failed_at: string | null;
- readonly failed_reason: string | null;
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
+ /** User */
+ readonly creator: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ readonly description: string | null;
+ /** Format: date-time */
+ readonly due_on: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ readonly id: number;
+ /** Format: uri */
+ readonly labels_url: string;
+ readonly node_id: string;
+ /** @description The number of the milestone. */
+ readonly number: number;
+ readonly open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ /** @description The title of the milestone. */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /** Format: uri */
+ readonly url: string;
+ } | null;
+ readonly node_id: string;
+ readonly number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ readonly performed_via_github_app?: {
+ /** Format: date-time */
+ readonly created_at: string | null;
+ readonly description: string | null;
+ /** @description The list of events for the GitHub app */
+ readonly events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ /** Format: uri */
+ readonly external_url: string | null;
+ /** Format: uri */
+ readonly html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ readonly id: number | null;
+ /** @description The name of the GitHub app */
+ readonly name: string;
+ readonly node_id: string;
+ /** User */
+ readonly owner: {
+ /** Format: uri */
+ readonly avatar_url?: string;
+ readonly deleted?: boolean;
+ readonly email?: string | null;
+ /** Format: uri-template */
+ readonly events_url?: string;
+ /** Format: uri */
+ readonly followers_url?: string;
+ /** Format: uri-template */
+ readonly following_url?: string;
+ /** Format: uri-template */
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ readonly id: number;
+ readonly login: string;
+ readonly name?: string;
+ readonly node_id?: string;
+ /** Format: uri */
+ readonly organizations_url?: string;
+ /** Format: uri */
+ readonly received_events_url?: string;
+ /** Format: uri */
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ /** Format: uri-template */
+ readonly starred_url?: string;
+ /** Format: uri */
+ readonly subscriptions_url?: string;
+ /** @enum {string} */
+ readonly type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ readonly url?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ readonly permissions?: {
+ /** @enum {string} */
+ readonly actions?: "read" | "write";
+ /** @enum {string} */
+ readonly administration?: "read" | "write";
+ /** @enum {string} */
+ readonly checks?: "read" | "write";
+ /** @enum {string} */
+ readonly content_references?: "read" | "write";
+ /** @enum {string} */
+ readonly contents?: "read" | "write";
+ /** @enum {string} */
+ readonly deployments?: "read" | "write";
+ /** @enum {string} */
+ readonly discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly emails?: "read" | "write";
+ /** @enum {string} */
+ readonly environments?: "read" | "write";
+ /** @enum {string} */
+ readonly issues?: "read" | "write";
+ /** @enum {string} */
+ readonly keys?: "read" | "write";
+ /** @enum {string} */
+ readonly members?: "read" | "write";
+ /** @enum {string} */
+ readonly metadata?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_administration?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_packages?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_plan?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ readonly organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ readonly packages?: "read" | "write";
+ /** @enum {string} */
+ readonly pages?: "read" | "write";
+ /** @enum {string} */
+ readonly pull_requests?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ readonly repository_projects?: "read" | "write";
+ /** @enum {string} */
+ readonly secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly secrets?: "read" | "write";
+ /** @enum {string} */
+ readonly security_events?: "read" | "write";
+ /** @enum {string} */
+ readonly security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ readonly single_file?: "read" | "write";
+ /** @enum {string} */
+ readonly statuses?: "read" | "write";
+ /** @enum {string} */
+ readonly team_discussions?: "read" | "write";
+ /** @enum {string} */
+ readonly vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ readonly workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ readonly slug?: string;
+ /** Format: date-time */
+ readonly updated_at: string | null;
+ } | null;
+ readonly pull_request?: {
+ /** Format: uri */
+ readonly diff_url?: string;
+ /** Format: uri */
+ readonly html_url?: string;
+ /** Format: date-time */
+ readonly merged_at?: string | null;
+ /** Format: uri */
+ readonly patch_url?: string;
+ /** Format: uri */
+ readonly url?: string;
+ };
+ /** Reactions */
+ readonly reactions: {
+ readonly "+1": number;
+ readonly "-1": number;
+ readonly confused: number;
+ readonly eyes: number;
+ readonly heart: number;
+ readonly hooray: number;
+ readonly laugh: number;
+ readonly rocket: number;
+ readonly total_count: number;
+ /** Format: uri */
+ readonly url: string;
+ };
/** Format: uri */
- readonly invitation_teams_url: string;
+ readonly repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state?: "open" | "closed";
+ readonly state_reason?: string | null;
+ /** Format: uri */
+ readonly timeline_url?: string;
+ /** @description Title of the issue */
+ readonly title: string;
+ /** Format: date-time */
+ readonly updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ readonly url: string;
/** User */
- readonly inviter: {
+ readonly user: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50885,76 +43121,14 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- readonly login: string | null;
- readonly node_id: string;
- readonly role: string;
- readonly team_count: number;
- readonly invitation_source?: string;
- };
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- /** User */
- readonly user?: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- } | null;
- };
- /** organization member_removed event */
- readonly "webhook-organization-member-removed": {
- /** @enum {string} */
- readonly action: "member_removed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Membership
- * @description The membership between the user and the organization. Not present when the action is `member_invited`.
- */
- readonly membership: {
- /** Format: uri */
- readonly organization_url: string;
- readonly role: string;
- readonly state: string;
- /** Format: uri */
- readonly url: string;
+ } & {
+ readonly active_lock_reason?: string | null;
/** User */
- readonly user: {
+ readonly assignee: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -50986,39 +43160,102 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
+ readonly assignees?: Record[];
+ readonly author_association?: string;
+ readonly body?: string | null;
+ readonly closed_at?: string | null;
+ readonly comments?: number;
+ readonly comments_url?: string;
+ readonly created_at?: string;
+ readonly events_url?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ readonly labels_url?: string;
+ readonly locked: boolean;
+ readonly milestone?: Record;
+ readonly node_id?: string;
+ readonly number?: number;
+ readonly performed_via_github_app?: Record;
+ readonly reactions?: {
+ readonly "+1"?: number;
+ readonly "-1"?: number;
+ readonly confused?: number;
+ readonly eyes?: number;
+ readonly heart?: number;
+ readonly hooray?: number;
+ readonly laugh?: number;
+ readonly rocket?: number;
+ readonly total_count?: number;
+ readonly url?: string;
+ };
+ readonly repository_url?: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ readonly state: "open" | "closed";
+ readonly timeline_url?: string;
+ readonly title?: string;
+ readonly updated_at?: string;
+ readonly url?: string;
+ readonly user?: {
+ readonly avatar_url?: string;
+ readonly events_url?: string;
+ readonly followers_url?: string;
+ readonly following_url?: string;
+ readonly gists_url?: string;
+ readonly gravatar_id?: string;
+ readonly html_url?: string;
+ readonly id?: number;
+ readonly login?: string;
+ readonly node_id?: string;
+ readonly organizations_url?: string;
+ readonly received_events_url?: string;
+ readonly repos_url?: string;
+ readonly site_admin?: boolean;
+ readonly starred_url?: string;
+ readonly subscriptions_url?: string;
+ readonly type?: string;
+ readonly url?: string;
+ };
};
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
+ readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ readonly repository: components["schemas"]["repository-webhooks"];
readonly sender: components["schemas"]["simple-user-webhooks"];
};
- /** organization renamed event */
- readonly "webhook-organization-renamed": {
+ /** issue_comment edited event */
+ readonly "webhook-issue-comment-edited": {
/** @enum {string} */
- readonly action: "renamed";
- readonly changes?: {
- readonly login?: {
- readonly from?: string;
- };
- };
+ readonly action: "edited";
+ readonly changes: components["schemas"]["webhooks_changes"];
+ readonly comment: components["schemas"]["webhooks_issue_comment"];
readonly enterprise?: components["schemas"]["enterprise-webhooks"];
readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Membership
- * @description The membership between the user and the organization. Not present when the action is `member_invited`.
- */
- readonly membership?: {
- /** Format: uri */
- readonly organization_url: string;
- readonly role: string;
- readonly state: string;
- /** Format: uri */
- readonly url: string;
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
+ readonly issue: {
+ /** @enum {string|null} */
+ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly user: {
+ readonly assignee?: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -51050,53 +43287,11 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- };
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user-webhooks"];
- };
- /** Ruby Gems metadata */
- readonly "webhook-rubygems-metadata": {
- readonly name?: string;
- readonly description?: string;
- readonly readme?: string;
- readonly homepage?: string;
- readonly version_info?: {
- readonly version?: string;
- };
- readonly platform?: string;
- readonly metadata?: {
- readonly [key: string]: string | undefined;
- };
- readonly repo?: string;
- readonly dependencies?: {
- readonly [key: string]: string | undefined;
- }[];
- readonly commit_oid?: string;
- };
- /** package published event */
- readonly "webhook-package-published": {
- /** @enum {string} */
- readonly action: "published";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- /** @description Information about the package. */
- readonly package: {
- readonly created_at: string | null;
- readonly description: string | null;
- readonly ecosystem: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly namespace: string;
- /** User */
- readonly owner: {
+ readonly assignees: ({
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -51128,14 +43323,62 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
- } | null;
- readonly package_type: string;
- readonly package_version: {
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ /** @description Contents of the issue */
+ readonly body: string | null;
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly comments: number;
+ /** Format: uri */
+ readonly comments_url: string;
+ /** Format: date-time */
+ readonly created_at: string;
+ readonly draft?: boolean;
+ /** Format: uri */
+ readonly events_url: string;
+ /** Format: uri */
+ readonly html_url: string;
+ /** Format: int64 */
+ readonly id: number;
+ readonly labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ readonly color: string;
+ readonly default: boolean;
+ readonly description: string | null;
+ readonly id: number;
+ /** @description The name of the label. */
+ readonly name: string;
+ readonly node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ readonly url: string;
+ }[];
+ /** Format: uri-template */
+ readonly labels_url: string;
+ readonly locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ readonly milestone: {
+ /** Format: date-time */
+ readonly closed_at: string | null;
+ readonly closed_issues: number;
+ /** Format: date-time */
+ readonly created_at: string;
/** User */
- readonly author?: {
+ readonly creator: {
/** Format: uri */
readonly avatar_url?: string;
readonly deleted?: boolean;
@@ -51167,193 +43410,399 @@ export interface components {
/** Format: uri */
readonly subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
readonly url?: string;
} | null;
- readonly body?: string | Record;
- readonly body_html?: string;
- readonly container_metadata?: {
- readonly labels?: Record