@octokit/openapi 16.2.0 → 16.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "16.2.0",
4
+ "version": "16.4.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": {
@@ -1758,7 +1758,7 @@
1758
1758
  "/app/installations/{installation_id}/access_tokens": {
1759
1759
  "post": {
1760
1760
  "summary": "Create an installation access token for an app",
1761
- "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. \n\nOptionally, 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.\n\nOptionally, 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.\n\nWhen 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. \n\nYou 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.",
1761
+ "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.\n\nOptionally, 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.\n\nOptionally, 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.\n\nWhen 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.\n\nYou 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.",
1762
1762
  "tags": [
1763
1763
  "apps"
1764
1764
  ],
@@ -11185,7 +11185,7 @@
11185
11185
  "/orgs/{org}/hooks": {
11186
11186
  "get": {
11187
11187
  "summary": "List organization webhooks",
11188
- "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11188
+ "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11189
11189
  "tags": [
11190
11190
  "orgs"
11191
11191
  ],
@@ -11243,7 +11243,7 @@
11243
11243
  },
11244
11244
  "post": {
11245
11245
  "summary": "Create an organization webhook",
11246
- "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or \nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11246
+ "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or\nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11247
11247
  "tags": [
11248
11248
  "orgs"
11249
11249
  ],
@@ -11380,7 +11380,7 @@
11380
11380
  "/orgs/{org}/hooks/{hook_id}": {
11381
11381
  "get": {
11382
11382
  "summary": "Get an organization webhook",
11383
- "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11383
+ "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11384
11384
  "tags": [
11385
11385
  "orgs"
11386
11386
  ],
@@ -11427,7 +11427,7 @@
11427
11427
  },
11428
11428
  "patch": {
11429
11429
  "summary": "Update an organization webhook",
11430
- "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11430
+ "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\".\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11431
11431
  "tags": [
11432
11432
  "orgs"
11433
11433
  ],
@@ -11539,7 +11539,7 @@
11539
11539
  },
11540
11540
  "delete": {
11541
11541
  "summary": "Delete an organization webhook",
11542
- "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11542
+ "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11543
11543
  "tags": [
11544
11544
  "orgs"
11545
11545
  ],
@@ -11576,7 +11576,7 @@
11576
11576
  "/orgs/{org}/hooks/{hook_id}/config": {
11577
11577
  "get": {
11578
11578
  "summary": "Get a webhook configuration for an organization",
11579
- "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11579
+ "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).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11580
11580
  "tags": [
11581
11581
  "orgs"
11582
11582
  ],
@@ -11620,7 +11620,7 @@
11620
11620
  },
11621
11621
  "patch": {
11622
11622
  "summary": "Update a webhook configuration for an organization",
11623
- "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11623
+ "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).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11624
11624
  "tags": [
11625
11625
  "orgs"
11626
11626
  ],
@@ -11701,7 +11701,7 @@
11701
11701
  "/orgs/{org}/hooks/{hook_id}/deliveries": {
11702
11702
  "get": {
11703
11703
  "summary": "List deliveries for an organization webhook",
11704
- "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11704
+ "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11705
11705
  "tags": [
11706
11706
  "orgs"
11707
11707
  ],
@@ -11770,7 +11770,7 @@
11770
11770
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
11771
11771
  "get": {
11772
11772
  "summary": "Get a webhook delivery for an organization webhook",
11773
- "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11773
+ "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11774
11774
  "tags": [
11775
11775
  "orgs"
11776
11776
  ],
@@ -11825,7 +11825,7 @@
11825
11825
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
11826
11826
  "post": {
11827
11827
  "summary": "Redeliver a delivery for an organization webhook",
11828
- "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11828
+ "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11829
11829
  "tags": [
11830
11830
  "orgs"
11831
11831
  ],
@@ -11868,7 +11868,7 @@
11868
11868
  "/orgs/{org}/hooks/{hook_id}/pings": {
11869
11869
  "post": {
11870
11870
  "summary": "Ping an organization webhook",
11871
- "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11871
+ "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
11872
11872
  "tags": [
11873
11873
  "orgs"
11874
11874
  ],
@@ -88026,6 +88026,56 @@
88026
88026
  "swift"
88027
88027
  ]
88028
88028
  },
88029
+ "vulnerability": {
88030
+ "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.",
88031
+ "type": "object",
88032
+ "properties": {
88033
+ "package": {
88034
+ "description": "The name of the package affected by the vulnerability.",
88035
+ "type": "object",
88036
+ "nullable": true,
88037
+ "properties": {
88038
+ "ecosystem": {
88039
+ "$ref": "#/components/schemas/security-advisory-ecosystems"
88040
+ },
88041
+ "name": {
88042
+ "type": "string",
88043
+ "description": "The unique package name within its ecosystem.",
88044
+ "nullable": true
88045
+ }
88046
+ },
88047
+ "required": [
88048
+ "ecosystem",
88049
+ "name"
88050
+ ]
88051
+ },
88052
+ "vulnerable_version_range": {
88053
+ "type": "string",
88054
+ "description": "The range of the package versions affected by the vulnerability.",
88055
+ "nullable": true
88056
+ },
88057
+ "first_patched_version": {
88058
+ "type": "string",
88059
+ "description": "The package version that resolves the vulnerability.",
88060
+ "nullable": true
88061
+ },
88062
+ "vulnerable_functions": {
88063
+ "type": "array",
88064
+ "description": "The functions in the package that are affected by the vulnerability.",
88065
+ "nullable": true,
88066
+ "readOnly": true,
88067
+ "items": {
88068
+ "type": "string"
88069
+ }
88070
+ }
88071
+ },
88072
+ "required": [
88073
+ "package",
88074
+ "vulnerable_version_range",
88075
+ "first_patched_version",
88076
+ "vulnerable_functions"
88077
+ ]
88078
+ },
88029
88079
  "simple-user": {
88030
88080
  "title": "Simple User",
88031
88081
  "description": "A GitHub user.",
@@ -88304,53 +88354,7 @@
88304
88354
  "description": "The products and respective version ranges affected by the advisory.",
88305
88355
  "nullable": true,
88306
88356
  "items": {
88307
- "type": "object",
88308
- "properties": {
88309
- "package": {
88310
- "description": "The name of the package affected by the vulnerability.",
88311
- "type": "object",
88312
- "nullable": true,
88313
- "properties": {
88314
- "ecosystem": {
88315
- "$ref": "#/components/schemas/security-advisory-ecosystems"
88316
- },
88317
- "name": {
88318
- "type": "string",
88319
- "description": "The unique package name within its ecosystem.",
88320
- "nullable": true
88321
- }
88322
- },
88323
- "required": [
88324
- "ecosystem",
88325
- "name"
88326
- ]
88327
- },
88328
- "vulnerable_version_range": {
88329
- "type": "string",
88330
- "description": "The range of the package versions affected by the vulnerability.",
88331
- "nullable": true
88332
- },
88333
- "first_patched_version": {
88334
- "type": "string",
88335
- "description": "The package version that resolve the vulnerability.",
88336
- "nullable": true
88337
- },
88338
- "vulnerable_functions": {
88339
- "type": "array",
88340
- "description": "The functions in the package that are affected by the vulnerability.",
88341
- "nullable": true,
88342
- "readOnly": true,
88343
- "items": {
88344
- "type": "string"
88345
- }
88346
- }
88347
- },
88348
- "required": [
88349
- "package",
88350
- "vulnerable_version_range",
88351
- "first_patched_version",
88352
- "vulnerable_functions"
88353
- ]
88357
+ "$ref": "#/components/schemas/vulnerability"
88354
88358
  }
88355
88359
  },
88356
88360
  "cvss": {
@@ -120302,6 +120306,171 @@
120302
120306
  "url"
120303
120307
  ]
120304
120308
  },
120309
+ "webhooks_rule": {
120310
+ "title": "branch protection rule",
120311
+ "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.",
120312
+ "type": "object",
120313
+ "properties": {
120314
+ "admin_enforced": {
120315
+ "type": "boolean"
120316
+ },
120317
+ "allow_deletions_enforcement_level": {
120318
+ "type": "string",
120319
+ "enum": [
120320
+ "off",
120321
+ "non_admins",
120322
+ "everyone"
120323
+ ]
120324
+ },
120325
+ "allow_force_pushes_enforcement_level": {
120326
+ "type": "string",
120327
+ "enum": [
120328
+ "off",
120329
+ "non_admins",
120330
+ "everyone"
120331
+ ]
120332
+ },
120333
+ "authorized_actor_names": {
120334
+ "type": "array",
120335
+ "items": {
120336
+ "type": "string"
120337
+ }
120338
+ },
120339
+ "authorized_actors_only": {
120340
+ "type": "boolean"
120341
+ },
120342
+ "authorized_dismissal_actors_only": {
120343
+ "type": "boolean"
120344
+ },
120345
+ "create_protected": {
120346
+ "type": "boolean"
120347
+ },
120348
+ "created_at": {
120349
+ "type": "string",
120350
+ "format": "date-time"
120351
+ },
120352
+ "dismiss_stale_reviews_on_push": {
120353
+ "type": "boolean"
120354
+ },
120355
+ "id": {
120356
+ "type": "integer"
120357
+ },
120358
+ "ignore_approvals_from_contributors": {
120359
+ "type": "boolean"
120360
+ },
120361
+ "linear_history_requirement_enforcement_level": {
120362
+ "type": "string",
120363
+ "enum": [
120364
+ "off",
120365
+ "non_admins",
120366
+ "everyone"
120367
+ ]
120368
+ },
120369
+ "merge_queue_enforcement_level": {
120370
+ "type": "string",
120371
+ "enum": [
120372
+ "off",
120373
+ "non_admins",
120374
+ "everyone"
120375
+ ]
120376
+ },
120377
+ "name": {
120378
+ "type": "string"
120379
+ },
120380
+ "pull_request_reviews_enforcement_level": {
120381
+ "type": "string",
120382
+ "enum": [
120383
+ "off",
120384
+ "non_admins",
120385
+ "everyone"
120386
+ ]
120387
+ },
120388
+ "repository_id": {
120389
+ "type": "integer"
120390
+ },
120391
+ "require_code_owner_review": {
120392
+ "type": "boolean"
120393
+ },
120394
+ "require_last_push_approval": {
120395
+ "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
120396
+ "type": "boolean"
120397
+ },
120398
+ "required_approving_review_count": {
120399
+ "type": "integer"
120400
+ },
120401
+ "required_conversation_resolution_level": {
120402
+ "type": "string",
120403
+ "enum": [
120404
+ "off",
120405
+ "non_admins",
120406
+ "everyone"
120407
+ ]
120408
+ },
120409
+ "required_deployments_enforcement_level": {
120410
+ "type": "string",
120411
+ "enum": [
120412
+ "off",
120413
+ "non_admins",
120414
+ "everyone"
120415
+ ]
120416
+ },
120417
+ "required_status_checks": {
120418
+ "type": "array",
120419
+ "items": {
120420
+ "type": "string"
120421
+ }
120422
+ },
120423
+ "required_status_checks_enforcement_level": {
120424
+ "type": "string",
120425
+ "enum": [
120426
+ "off",
120427
+ "non_admins",
120428
+ "everyone"
120429
+ ]
120430
+ },
120431
+ "signature_requirement_enforcement_level": {
120432
+ "type": "string",
120433
+ "enum": [
120434
+ "off",
120435
+ "non_admins",
120436
+ "everyone"
120437
+ ]
120438
+ },
120439
+ "strict_required_status_checks_policy": {
120440
+ "type": "boolean"
120441
+ },
120442
+ "updated_at": {
120443
+ "type": "string",
120444
+ "format": "date-time"
120445
+ }
120446
+ },
120447
+ "required": [
120448
+ "id",
120449
+ "repository_id",
120450
+ "name",
120451
+ "created_at",
120452
+ "updated_at",
120453
+ "pull_request_reviews_enforcement_level",
120454
+ "required_approving_review_count",
120455
+ "dismiss_stale_reviews_on_push",
120456
+ "require_code_owner_review",
120457
+ "authorized_dismissal_actors_only",
120458
+ "ignore_approvals_from_contributors",
120459
+ "required_status_checks",
120460
+ "required_status_checks_enforcement_level",
120461
+ "strict_required_status_checks_policy",
120462
+ "signature_requirement_enforcement_level",
120463
+ "linear_history_requirement_enforcement_level",
120464
+ "admin_enforced",
120465
+ "allow_force_pushes_enforcement_level",
120466
+ "allow_deletions_enforcement_level",
120467
+ "merge_queue_enforcement_level",
120468
+ "required_deployments_enforcement_level",
120469
+ "required_conversation_resolution_level",
120470
+ "authorized_actors_only",
120471
+ "authorized_actor_names"
120472
+ ]
120473
+ },
120305
120474
  "simple-check-suite": {
120306
120475
  "description": "A suite of checks performed on the code of a given code change",
120307
120476
  "type": "object",
@@ -122435,169 +122604,7 @@
122435
122604
  "$ref": "#/components/schemas/repository-webhooks"
122436
122605
  },
122437
122606
  "rule": {
122438
- "title": "branch protection rule",
122439
- "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.",
122440
- "type": "object",
122441
- "properties": {
122442
- "admin_enforced": {
122443
- "type": "boolean"
122444
- },
122445
- "allow_deletions_enforcement_level": {
122446
- "type": "string",
122447
- "enum": [
122448
- "off",
122449
- "non_admins",
122450
- "everyone"
122451
- ]
122452
- },
122453
- "allow_force_pushes_enforcement_level": {
122454
- "type": "string",
122455
- "enum": [
122456
- "off",
122457
- "non_admins",
122458
- "everyone"
122459
- ]
122460
- },
122461
- "authorized_actor_names": {
122462
- "type": "array",
122463
- "items": {
122464
- "type": "string"
122465
- }
122466
- },
122467
- "authorized_actors_only": {
122468
- "type": "boolean"
122469
- },
122470
- "authorized_dismissal_actors_only": {
122471
- "type": "boolean"
122472
- },
122473
- "create_protected": {
122474
- "type": "boolean"
122475
- },
122476
- "created_at": {
122477
- "type": "string",
122478
- "format": "date-time"
122479
- },
122480
- "dismiss_stale_reviews_on_push": {
122481
- "type": "boolean"
122482
- },
122483
- "id": {
122484
- "type": "integer"
122485
- },
122486
- "ignore_approvals_from_contributors": {
122487
- "type": "boolean"
122488
- },
122489
- "linear_history_requirement_enforcement_level": {
122490
- "type": "string",
122491
- "enum": [
122492
- "off",
122493
- "non_admins",
122494
- "everyone"
122495
- ]
122496
- },
122497
- "merge_queue_enforcement_level": {
122498
- "type": "string",
122499
- "enum": [
122500
- "off",
122501
- "non_admins",
122502
- "everyone"
122503
- ]
122504
- },
122505
- "name": {
122506
- "type": "string"
122507
- },
122508
- "pull_request_reviews_enforcement_level": {
122509
- "type": "string",
122510
- "enum": [
122511
- "off",
122512
- "non_admins",
122513
- "everyone"
122514
- ]
122515
- },
122516
- "repository_id": {
122517
- "type": "integer"
122518
- },
122519
- "require_code_owner_review": {
122520
- "type": "boolean"
122521
- },
122522
- "require_last_push_approval": {
122523
- "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
122524
- "type": "boolean"
122525
- },
122526
- "required_approving_review_count": {
122527
- "type": "integer"
122528
- },
122529
- "required_conversation_resolution_level": {
122530
- "type": "string",
122531
- "enum": [
122532
- "off",
122533
- "non_admins",
122534
- "everyone"
122535
- ]
122536
- },
122537
- "required_deployments_enforcement_level": {
122538
- "type": "string",
122539
- "enum": [
122540
- "off",
122541
- "non_admins",
122542
- "everyone"
122543
- ]
122544
- },
122545
- "required_status_checks": {
122546
- "type": "array",
122547
- "items": {
122548
- "type": "string"
122549
- }
122550
- },
122551
- "required_status_checks_enforcement_level": {
122552
- "type": "string",
122553
- "enum": [
122554
- "off",
122555
- "non_admins",
122556
- "everyone"
122557
- ]
122558
- },
122559
- "signature_requirement_enforcement_level": {
122560
- "type": "string",
122561
- "enum": [
122562
- "off",
122563
- "non_admins",
122564
- "everyone"
122565
- ]
122566
- },
122567
- "strict_required_status_checks_policy": {
122568
- "type": "boolean"
122569
- },
122570
- "updated_at": {
122571
- "type": "string",
122572
- "format": "date-time"
122573
- }
122574
- },
122575
- "required": [
122576
- "id",
122577
- "repository_id",
122578
- "name",
122579
- "created_at",
122580
- "updated_at",
122581
- "pull_request_reviews_enforcement_level",
122582
- "required_approving_review_count",
122583
- "dismiss_stale_reviews_on_push",
122584
- "require_code_owner_review",
122585
- "authorized_dismissal_actors_only",
122586
- "ignore_approvals_from_contributors",
122587
- "required_status_checks",
122588
- "required_status_checks_enforcement_level",
122589
- "strict_required_status_checks_policy",
122590
- "signature_requirement_enforcement_level",
122591
- "linear_history_requirement_enforcement_level",
122592
- "admin_enforced",
122593
- "allow_force_pushes_enforcement_level",
122594
- "allow_deletions_enforcement_level",
122595
- "merge_queue_enforcement_level",
122596
- "required_deployments_enforcement_level",
122597
- "required_conversation_resolution_level",
122598
- "authorized_actors_only",
122599
- "authorized_actor_names"
122600
- ]
122607
+ "$ref": "#/components/schemas/webhooks_rule"
122601
122608
  },
122602
122609
  "sender": {
122603
122610
  "$ref": "#/components/schemas/simple-user-webhooks"
@@ -122633,169 +122640,7 @@
122633
122640
  "$ref": "#/components/schemas/repository-webhooks"
122634
122641
  },
122635
122642
  "rule": {
122636
- "title": "branch protection rule",
122637
- "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.",
122638
- "type": "object",
122639
- "properties": {
122640
- "admin_enforced": {
122641
- "type": "boolean"
122642
- },
122643
- "allow_deletions_enforcement_level": {
122644
- "type": "string",
122645
- "enum": [
122646
- "off",
122647
- "non_admins",
122648
- "everyone"
122649
- ]
122650
- },
122651
- "allow_force_pushes_enforcement_level": {
122652
- "type": "string",
122653
- "enum": [
122654
- "off",
122655
- "non_admins",
122656
- "everyone"
122657
- ]
122658
- },
122659
- "authorized_actor_names": {
122660
- "type": "array",
122661
- "items": {
122662
- "type": "string"
122663
- }
122664
- },
122665
- "authorized_actors_only": {
122666
- "type": "boolean"
122667
- },
122668
- "authorized_dismissal_actors_only": {
122669
- "type": "boolean"
122670
- },
122671
- "create_protected": {
122672
- "type": "boolean"
122673
- },
122674
- "created_at": {
122675
- "type": "string",
122676
- "format": "date-time"
122677
- },
122678
- "dismiss_stale_reviews_on_push": {
122679
- "type": "boolean"
122680
- },
122681
- "id": {
122682
- "type": "integer"
122683
- },
122684
- "ignore_approvals_from_contributors": {
122685
- "type": "boolean"
122686
- },
122687
- "linear_history_requirement_enforcement_level": {
122688
- "type": "string",
122689
- "enum": [
122690
- "off",
122691
- "non_admins",
122692
- "everyone"
122693
- ]
122694
- },
122695
- "merge_queue_enforcement_level": {
122696
- "type": "string",
122697
- "enum": [
122698
- "off",
122699
- "non_admins",
122700
- "everyone"
122701
- ]
122702
- },
122703
- "name": {
122704
- "type": "string"
122705
- },
122706
- "pull_request_reviews_enforcement_level": {
122707
- "type": "string",
122708
- "enum": [
122709
- "off",
122710
- "non_admins",
122711
- "everyone"
122712
- ]
122713
- },
122714
- "repository_id": {
122715
- "type": "integer"
122716
- },
122717
- "require_code_owner_review": {
122718
- "type": "boolean"
122719
- },
122720
- "require_last_push_approval": {
122721
- "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
122722
- "type": "boolean"
122723
- },
122724
- "required_approving_review_count": {
122725
- "type": "integer"
122726
- },
122727
- "required_conversation_resolution_level": {
122728
- "type": "string",
122729
- "enum": [
122730
- "off",
122731
- "non_admins",
122732
- "everyone"
122733
- ]
122734
- },
122735
- "required_deployments_enforcement_level": {
122736
- "type": "string",
122737
- "enum": [
122738
- "off",
122739
- "non_admins",
122740
- "everyone"
122741
- ]
122742
- },
122743
- "required_status_checks": {
122744
- "type": "array",
122745
- "items": {
122746
- "type": "string"
122747
- }
122748
- },
122749
- "required_status_checks_enforcement_level": {
122750
- "type": "string",
122751
- "enum": [
122752
- "off",
122753
- "non_admins",
122754
- "everyone"
122755
- ]
122756
- },
122757
- "signature_requirement_enforcement_level": {
122758
- "type": "string",
122759
- "enum": [
122760
- "off",
122761
- "non_admins",
122762
- "everyone"
122763
- ]
122764
- },
122765
- "strict_required_status_checks_policy": {
122766
- "type": "boolean"
122767
- },
122768
- "updated_at": {
122769
- "type": "string",
122770
- "format": "date-time"
122771
- }
122772
- },
122773
- "required": [
122774
- "id",
122775
- "repository_id",
122776
- "name",
122777
- "created_at",
122778
- "updated_at",
122779
- "pull_request_reviews_enforcement_level",
122780
- "required_approving_review_count",
122781
- "dismiss_stale_reviews_on_push",
122782
- "require_code_owner_review",
122783
- "authorized_dismissal_actors_only",
122784
- "ignore_approvals_from_contributors",
122785
- "required_status_checks",
122786
- "required_status_checks_enforcement_level",
122787
- "strict_required_status_checks_policy",
122788
- "signature_requirement_enforcement_level",
122789
- "linear_history_requirement_enforcement_level",
122790
- "admin_enforced",
122791
- "allow_force_pushes_enforcement_level",
122792
- "allow_deletions_enforcement_level",
122793
- "merge_queue_enforcement_level",
122794
- "required_deployments_enforcement_level",
122795
- "required_conversation_resolution_level",
122796
- "authorized_actors_only",
122797
- "authorized_actor_names"
122798
- ]
122643
+ "$ref": "#/components/schemas/webhooks_rule"
122799
122644
  },
122800
122645
  "sender": {
122801
122646
  "$ref": "#/components/schemas/simple-user-webhooks"
@@ -122933,169 +122778,7 @@
122933
122778
  "$ref": "#/components/schemas/repository-webhooks"
122934
122779
  },
122935
122780
  "rule": {
122936
- "title": "branch protection rule",
122937
- "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.",
122938
- "type": "object",
122939
- "properties": {
122940
- "admin_enforced": {
122941
- "type": "boolean"
122942
- },
122943
- "allow_deletions_enforcement_level": {
122944
- "type": "string",
122945
- "enum": [
122946
- "off",
122947
- "non_admins",
122948
- "everyone"
122949
- ]
122950
- },
122951
- "allow_force_pushes_enforcement_level": {
122952
- "type": "string",
122953
- "enum": [
122954
- "off",
122955
- "non_admins",
122956
- "everyone"
122957
- ]
122958
- },
122959
- "authorized_actor_names": {
122960
- "type": "array",
122961
- "items": {
122962
- "type": "string"
122963
- }
122964
- },
122965
- "authorized_actors_only": {
122966
- "type": "boolean"
122967
- },
122968
- "authorized_dismissal_actors_only": {
122969
- "type": "boolean"
122970
- },
122971
- "create_protected": {
122972
- "type": "boolean"
122973
- },
122974
- "created_at": {
122975
- "type": "string",
122976
- "format": "date-time"
122977
- },
122978
- "dismiss_stale_reviews_on_push": {
122979
- "type": "boolean"
122980
- },
122981
- "id": {
122982
- "type": "integer"
122983
- },
122984
- "ignore_approvals_from_contributors": {
122985
- "type": "boolean"
122986
- },
122987
- "linear_history_requirement_enforcement_level": {
122988
- "type": "string",
122989
- "enum": [
122990
- "off",
122991
- "non_admins",
122992
- "everyone"
122993
- ]
122994
- },
122995
- "merge_queue_enforcement_level": {
122996
- "type": "string",
122997
- "enum": [
122998
- "off",
122999
- "non_admins",
123000
- "everyone"
123001
- ]
123002
- },
123003
- "name": {
123004
- "type": "string"
123005
- },
123006
- "pull_request_reviews_enforcement_level": {
123007
- "type": "string",
123008
- "enum": [
123009
- "off",
123010
- "non_admins",
123011
- "everyone"
123012
- ]
123013
- },
123014
- "repository_id": {
123015
- "type": "integer"
123016
- },
123017
- "require_code_owner_review": {
123018
- "type": "boolean"
123019
- },
123020
- "require_last_push_approval": {
123021
- "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
123022
- "type": "boolean"
123023
- },
123024
- "required_approving_review_count": {
123025
- "type": "integer"
123026
- },
123027
- "required_conversation_resolution_level": {
123028
- "type": "string",
123029
- "enum": [
123030
- "off",
123031
- "non_admins",
123032
- "everyone"
123033
- ]
123034
- },
123035
- "required_deployments_enforcement_level": {
123036
- "type": "string",
123037
- "enum": [
123038
- "off",
123039
- "non_admins",
123040
- "everyone"
123041
- ]
123042
- },
123043
- "required_status_checks": {
123044
- "type": "array",
123045
- "items": {
123046
- "type": "string"
123047
- }
123048
- },
123049
- "required_status_checks_enforcement_level": {
123050
- "type": "string",
123051
- "enum": [
123052
- "off",
123053
- "non_admins",
123054
- "everyone"
123055
- ]
123056
- },
123057
- "signature_requirement_enforcement_level": {
123058
- "type": "string",
123059
- "enum": [
123060
- "off",
123061
- "non_admins",
123062
- "everyone"
123063
- ]
123064
- },
123065
- "strict_required_status_checks_policy": {
123066
- "type": "boolean"
123067
- },
123068
- "updated_at": {
123069
- "type": "string",
123070
- "format": "date-time"
123071
- }
123072
- },
123073
- "required": [
123074
- "id",
123075
- "repository_id",
123076
- "name",
123077
- "created_at",
123078
- "updated_at",
123079
- "pull_request_reviews_enforcement_level",
123080
- "required_approving_review_count",
123081
- "dismiss_stale_reviews_on_push",
123082
- "require_code_owner_review",
123083
- "authorized_dismissal_actors_only",
123084
- "ignore_approvals_from_contributors",
123085
- "required_status_checks",
123086
- "required_status_checks_enforcement_level",
123087
- "strict_required_status_checks_policy",
123088
- "signature_requirement_enforcement_level",
123089
- "linear_history_requirement_enforcement_level",
123090
- "admin_enforced",
123091
- "allow_force_pushes_enforcement_level",
123092
- "allow_deletions_enforcement_level",
123093
- "merge_queue_enforcement_level",
123094
- "required_deployments_enforcement_level",
123095
- "required_conversation_resolution_level",
123096
- "authorized_actors_only",
123097
- "authorized_actor_names"
123098
- ]
122781
+ "$ref": "#/components/schemas/webhooks_rule"
123099
122782
  },
123100
122783
  "sender": {
123101
122784
  "$ref": "#/components/schemas/simple-user-webhooks"