@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": {
@@ -3839,7 +3839,7 @@
3839
3839
  "/app/installations/{installation_id}/access_tokens": {
3840
3840
  "post": {
3841
3841
  "summary": "Create an installation access token for an app",
3842
- "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/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
3842
+ "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/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
3843
3843
  "tags": [
3844
3844
  "apps"
3845
3845
  ],
@@ -16630,7 +16630,7 @@
16630
16630
  "/orgs/{org}/hooks": {
16631
16631
  "get": {
16632
16632
  "summary": "List organization webhooks",
16633
- "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.",
16633
+ "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.",
16634
16634
  "tags": [
16635
16635
  "orgs"
16636
16636
  ],
@@ -16688,7 +16688,7 @@
16688
16688
  },
16689
16689
  "post": {
16690
16690
  "summary": "Create an organization webhook",
16691
- "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.",
16691
+ "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.",
16692
16692
  "tags": [
16693
16693
  "orgs"
16694
16694
  ],
@@ -16825,7 +16825,7 @@
16825
16825
  "/orgs/{org}/hooks/{hook_id}": {
16826
16826
  "get": {
16827
16827
  "summary": "Get an organization webhook",
16828
- "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.",
16828
+ "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.",
16829
16829
  "tags": [
16830
16830
  "orgs"
16831
16831
  ],
@@ -16872,7 +16872,7 @@
16872
16872
  },
16873
16873
  "patch": {
16874
16874
  "summary": "Update an organization webhook",
16875
- "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.",
16875
+ "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.",
16876
16876
  "tags": [
16877
16877
  "orgs"
16878
16878
  ],
@@ -16984,7 +16984,7 @@
16984
16984
  },
16985
16985
  "delete": {
16986
16986
  "summary": "Delete an organization webhook",
16987
- "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.",
16987
+ "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.",
16988
16988
  "tags": [
16989
16989
  "orgs"
16990
16990
  ],
@@ -17021,7 +17021,7 @@
17021
17021
  "/orgs/{org}/hooks/{hook_id}/config": {
17022
17022
  "get": {
17023
17023
  "summary": "Get a webhook configuration for an organization",
17024
- "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.",
17024
+ "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.",
17025
17025
  "tags": [
17026
17026
  "orgs"
17027
17027
  ],
@@ -17065,7 +17065,7 @@
17065
17065
  },
17066
17066
  "patch": {
17067
17067
  "summary": "Update a webhook configuration for an organization",
17068
- "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.",
17068
+ "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.",
17069
17069
  "tags": [
17070
17070
  "orgs"
17071
17071
  ],
@@ -17146,7 +17146,7 @@
17146
17146
  "/orgs/{org}/hooks/{hook_id}/deliveries": {
17147
17147
  "get": {
17148
17148
  "summary": "List deliveries for an organization webhook",
17149
- "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.",
17149
+ "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.",
17150
17150
  "tags": [
17151
17151
  "orgs"
17152
17152
  ],
@@ -17215,7 +17215,7 @@
17215
17215
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
17216
17216
  "get": {
17217
17217
  "summary": "Get a webhook delivery for an organization webhook",
17218
- "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.",
17218
+ "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.",
17219
17219
  "tags": [
17220
17220
  "orgs"
17221
17221
  ],
@@ -17270,7 +17270,7 @@
17270
17270
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
17271
17271
  "post": {
17272
17272
  "summary": "Redeliver a delivery for an organization webhook",
17273
- "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.",
17273
+ "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.",
17274
17274
  "tags": [
17275
17275
  "orgs"
17276
17276
  ],
@@ -17313,7 +17313,7 @@
17313
17313
  "/orgs/{org}/hooks/{hook_id}/pings": {
17314
17314
  "post": {
17315
17315
  "summary": "Ping an organization webhook",
17316
- "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/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.",
17316
+ "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/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.",
17317
17317
  "tags": [
17318
17318
  "orgs"
17319
17319
  ],
@@ -91626,6 +91626,56 @@
91626
91626
  "swift"
91627
91627
  ]
91628
91628
  },
91629
+ "vulnerability": {
91630
+ "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.",
91631
+ "type": "object",
91632
+ "properties": {
91633
+ "package": {
91634
+ "description": "The name of the package affected by the vulnerability.",
91635
+ "type": "object",
91636
+ "nullable": true,
91637
+ "properties": {
91638
+ "ecosystem": {
91639
+ "$ref": "#/components/schemas/security-advisory-ecosystems"
91640
+ },
91641
+ "name": {
91642
+ "type": "string",
91643
+ "description": "The unique package name within its ecosystem.",
91644
+ "nullable": true
91645
+ }
91646
+ },
91647
+ "required": [
91648
+ "ecosystem",
91649
+ "name"
91650
+ ]
91651
+ },
91652
+ "vulnerable_version_range": {
91653
+ "type": "string",
91654
+ "description": "The range of the package versions affected by the vulnerability.",
91655
+ "nullable": true
91656
+ },
91657
+ "first_patched_version": {
91658
+ "type": "string",
91659
+ "description": "The package version that resolves the vulnerability.",
91660
+ "nullable": true
91661
+ },
91662
+ "vulnerable_functions": {
91663
+ "type": "array",
91664
+ "description": "The functions in the package that are affected by the vulnerability.",
91665
+ "nullable": true,
91666
+ "readOnly": true,
91667
+ "items": {
91668
+ "type": "string"
91669
+ }
91670
+ }
91671
+ },
91672
+ "required": [
91673
+ "package",
91674
+ "vulnerable_version_range",
91675
+ "first_patched_version",
91676
+ "vulnerable_functions"
91677
+ ]
91678
+ },
91629
91679
  "security-advisory-credit-types": {
91630
91680
  "type": "string",
91631
91681
  "description": "The type of credit the user is receiving.",
@@ -91785,53 +91835,7 @@
91785
91835
  "description": "The products and respective version ranges affected by the advisory.",
91786
91836
  "nullable": true,
91787
91837
  "items": {
91788
- "type": "object",
91789
- "properties": {
91790
- "package": {
91791
- "description": "The name of the package affected by the vulnerability.",
91792
- "type": "object",
91793
- "nullable": true,
91794
- "properties": {
91795
- "ecosystem": {
91796
- "$ref": "#/components/schemas/security-advisory-ecosystems"
91797
- },
91798
- "name": {
91799
- "type": "string",
91800
- "description": "The unique package name within its ecosystem.",
91801
- "nullable": true
91802
- }
91803
- },
91804
- "required": [
91805
- "ecosystem",
91806
- "name"
91807
- ]
91808
- },
91809
- "vulnerable_version_range": {
91810
- "type": "string",
91811
- "description": "The range of the package versions affected by the vulnerability.",
91812
- "nullable": true
91813
- },
91814
- "first_patched_version": {
91815
- "type": "string",
91816
- "description": "The package version that resolve the vulnerability.",
91817
- "nullable": true
91818
- },
91819
- "vulnerable_functions": {
91820
- "type": "array",
91821
- "description": "The functions in the package that are affected by the vulnerability.",
91822
- "nullable": true,
91823
- "readOnly": true,
91824
- "items": {
91825
- "type": "string"
91826
- }
91827
- }
91828
- },
91829
- "required": [
91830
- "package",
91831
- "vulnerable_version_range",
91832
- "first_patched_version",
91833
- "vulnerable_functions"
91834
- ]
91838
+ "$ref": "#/components/schemas/vulnerability"
91835
91839
  }
91836
91840
  },
91837
91841
  "cvss": {
@@ -121143,6 +121147,171 @@
121143
121147
  "url"
121144
121148
  ]
121145
121149
  },
121150
+ "webhooks_rule": {
121151
+ "title": "branch protection rule",
121152
+ "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/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.",
121153
+ "type": "object",
121154
+ "properties": {
121155
+ "admin_enforced": {
121156
+ "type": "boolean"
121157
+ },
121158
+ "allow_deletions_enforcement_level": {
121159
+ "type": "string",
121160
+ "enum": [
121161
+ "off",
121162
+ "non_admins",
121163
+ "everyone"
121164
+ ]
121165
+ },
121166
+ "allow_force_pushes_enforcement_level": {
121167
+ "type": "string",
121168
+ "enum": [
121169
+ "off",
121170
+ "non_admins",
121171
+ "everyone"
121172
+ ]
121173
+ },
121174
+ "authorized_actor_names": {
121175
+ "type": "array",
121176
+ "items": {
121177
+ "type": "string"
121178
+ }
121179
+ },
121180
+ "authorized_actors_only": {
121181
+ "type": "boolean"
121182
+ },
121183
+ "authorized_dismissal_actors_only": {
121184
+ "type": "boolean"
121185
+ },
121186
+ "create_protected": {
121187
+ "type": "boolean"
121188
+ },
121189
+ "created_at": {
121190
+ "type": "string",
121191
+ "format": "date-time"
121192
+ },
121193
+ "dismiss_stale_reviews_on_push": {
121194
+ "type": "boolean"
121195
+ },
121196
+ "id": {
121197
+ "type": "integer"
121198
+ },
121199
+ "ignore_approvals_from_contributors": {
121200
+ "type": "boolean"
121201
+ },
121202
+ "linear_history_requirement_enforcement_level": {
121203
+ "type": "string",
121204
+ "enum": [
121205
+ "off",
121206
+ "non_admins",
121207
+ "everyone"
121208
+ ]
121209
+ },
121210
+ "merge_queue_enforcement_level": {
121211
+ "type": "string",
121212
+ "enum": [
121213
+ "off",
121214
+ "non_admins",
121215
+ "everyone"
121216
+ ]
121217
+ },
121218
+ "name": {
121219
+ "type": "string"
121220
+ },
121221
+ "pull_request_reviews_enforcement_level": {
121222
+ "type": "string",
121223
+ "enum": [
121224
+ "off",
121225
+ "non_admins",
121226
+ "everyone"
121227
+ ]
121228
+ },
121229
+ "repository_id": {
121230
+ "type": "integer"
121231
+ },
121232
+ "require_code_owner_review": {
121233
+ "type": "boolean"
121234
+ },
121235
+ "require_last_push_approval": {
121236
+ "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
121237
+ "type": "boolean"
121238
+ },
121239
+ "required_approving_review_count": {
121240
+ "type": "integer"
121241
+ },
121242
+ "required_conversation_resolution_level": {
121243
+ "type": "string",
121244
+ "enum": [
121245
+ "off",
121246
+ "non_admins",
121247
+ "everyone"
121248
+ ]
121249
+ },
121250
+ "required_deployments_enforcement_level": {
121251
+ "type": "string",
121252
+ "enum": [
121253
+ "off",
121254
+ "non_admins",
121255
+ "everyone"
121256
+ ]
121257
+ },
121258
+ "required_status_checks": {
121259
+ "type": "array",
121260
+ "items": {
121261
+ "type": "string"
121262
+ }
121263
+ },
121264
+ "required_status_checks_enforcement_level": {
121265
+ "type": "string",
121266
+ "enum": [
121267
+ "off",
121268
+ "non_admins",
121269
+ "everyone"
121270
+ ]
121271
+ },
121272
+ "signature_requirement_enforcement_level": {
121273
+ "type": "string",
121274
+ "enum": [
121275
+ "off",
121276
+ "non_admins",
121277
+ "everyone"
121278
+ ]
121279
+ },
121280
+ "strict_required_status_checks_policy": {
121281
+ "type": "boolean"
121282
+ },
121283
+ "updated_at": {
121284
+ "type": "string",
121285
+ "format": "date-time"
121286
+ }
121287
+ },
121288
+ "required": [
121289
+ "id",
121290
+ "repository_id",
121291
+ "name",
121292
+ "created_at",
121293
+ "updated_at",
121294
+ "pull_request_reviews_enforcement_level",
121295
+ "required_approving_review_count",
121296
+ "dismiss_stale_reviews_on_push",
121297
+ "require_code_owner_review",
121298
+ "authorized_dismissal_actors_only",
121299
+ "ignore_approvals_from_contributors",
121300
+ "required_status_checks",
121301
+ "required_status_checks_enforcement_level",
121302
+ "strict_required_status_checks_policy",
121303
+ "signature_requirement_enforcement_level",
121304
+ "linear_history_requirement_enforcement_level",
121305
+ "admin_enforced",
121306
+ "allow_force_pushes_enforcement_level",
121307
+ "allow_deletions_enforcement_level",
121308
+ "merge_queue_enforcement_level",
121309
+ "required_deployments_enforcement_level",
121310
+ "required_conversation_resolution_level",
121311
+ "authorized_actors_only",
121312
+ "authorized_actor_names"
121313
+ ]
121314
+ },
121146
121315
  "simple-check-suite": {
121147
121316
  "description": "A suite of checks performed on the code of a given code change",
121148
121317
  "type": "object",
@@ -123238,169 +123407,7 @@
123238
123407
  "$ref": "#/components/schemas/repository-webhooks"
123239
123408
  },
123240
123409
  "rule": {
123241
- "title": "branch protection rule",
123242
- "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/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.",
123243
- "type": "object",
123244
- "properties": {
123245
- "admin_enforced": {
123246
- "type": "boolean"
123247
- },
123248
- "allow_deletions_enforcement_level": {
123249
- "type": "string",
123250
- "enum": [
123251
- "off",
123252
- "non_admins",
123253
- "everyone"
123254
- ]
123255
- },
123256
- "allow_force_pushes_enforcement_level": {
123257
- "type": "string",
123258
- "enum": [
123259
- "off",
123260
- "non_admins",
123261
- "everyone"
123262
- ]
123263
- },
123264
- "authorized_actor_names": {
123265
- "type": "array",
123266
- "items": {
123267
- "type": "string"
123268
- }
123269
- },
123270
- "authorized_actors_only": {
123271
- "type": "boolean"
123272
- },
123273
- "authorized_dismissal_actors_only": {
123274
- "type": "boolean"
123275
- },
123276
- "create_protected": {
123277
- "type": "boolean"
123278
- },
123279
- "created_at": {
123280
- "type": "string",
123281
- "format": "date-time"
123282
- },
123283
- "dismiss_stale_reviews_on_push": {
123284
- "type": "boolean"
123285
- },
123286
- "id": {
123287
- "type": "integer"
123288
- },
123289
- "ignore_approvals_from_contributors": {
123290
- "type": "boolean"
123291
- },
123292
- "linear_history_requirement_enforcement_level": {
123293
- "type": "string",
123294
- "enum": [
123295
- "off",
123296
- "non_admins",
123297
- "everyone"
123298
- ]
123299
- },
123300
- "merge_queue_enforcement_level": {
123301
- "type": "string",
123302
- "enum": [
123303
- "off",
123304
- "non_admins",
123305
- "everyone"
123306
- ]
123307
- },
123308
- "name": {
123309
- "type": "string"
123310
- },
123311
- "pull_request_reviews_enforcement_level": {
123312
- "type": "string",
123313
- "enum": [
123314
- "off",
123315
- "non_admins",
123316
- "everyone"
123317
- ]
123318
- },
123319
- "repository_id": {
123320
- "type": "integer"
123321
- },
123322
- "require_code_owner_review": {
123323
- "type": "boolean"
123324
- },
123325
- "require_last_push_approval": {
123326
- "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
123327
- "type": "boolean"
123328
- },
123329
- "required_approving_review_count": {
123330
- "type": "integer"
123331
- },
123332
- "required_conversation_resolution_level": {
123333
- "type": "string",
123334
- "enum": [
123335
- "off",
123336
- "non_admins",
123337
- "everyone"
123338
- ]
123339
- },
123340
- "required_deployments_enforcement_level": {
123341
- "type": "string",
123342
- "enum": [
123343
- "off",
123344
- "non_admins",
123345
- "everyone"
123346
- ]
123347
- },
123348
- "required_status_checks": {
123349
- "type": "array",
123350
- "items": {
123351
- "type": "string"
123352
- }
123353
- },
123354
- "required_status_checks_enforcement_level": {
123355
- "type": "string",
123356
- "enum": [
123357
- "off",
123358
- "non_admins",
123359
- "everyone"
123360
- ]
123361
- },
123362
- "signature_requirement_enforcement_level": {
123363
- "type": "string",
123364
- "enum": [
123365
- "off",
123366
- "non_admins",
123367
- "everyone"
123368
- ]
123369
- },
123370
- "strict_required_status_checks_policy": {
123371
- "type": "boolean"
123372
- },
123373
- "updated_at": {
123374
- "type": "string",
123375
- "format": "date-time"
123376
- }
123377
- },
123378
- "required": [
123379
- "id",
123380
- "repository_id",
123381
- "name",
123382
- "created_at",
123383
- "updated_at",
123384
- "pull_request_reviews_enforcement_level",
123385
- "required_approving_review_count",
123386
- "dismiss_stale_reviews_on_push",
123387
- "require_code_owner_review",
123388
- "authorized_dismissal_actors_only",
123389
- "ignore_approvals_from_contributors",
123390
- "required_status_checks",
123391
- "required_status_checks_enforcement_level",
123392
- "strict_required_status_checks_policy",
123393
- "signature_requirement_enforcement_level",
123394
- "linear_history_requirement_enforcement_level",
123395
- "admin_enforced",
123396
- "allow_force_pushes_enforcement_level",
123397
- "allow_deletions_enforcement_level",
123398
- "merge_queue_enforcement_level",
123399
- "required_deployments_enforcement_level",
123400
- "required_conversation_resolution_level",
123401
- "authorized_actors_only",
123402
- "authorized_actor_names"
123403
- ]
123410
+ "$ref": "#/components/schemas/webhooks_rule"
123404
123411
  },
123405
123412
  "sender": {
123406
123413
  "$ref": "#/components/schemas/simple-user-webhooks"
@@ -123436,169 +123443,7 @@
123436
123443
  "$ref": "#/components/schemas/repository-webhooks"
123437
123444
  },
123438
123445
  "rule": {
123439
- "title": "branch protection rule",
123440
- "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/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.",
123441
- "type": "object",
123442
- "properties": {
123443
- "admin_enforced": {
123444
- "type": "boolean"
123445
- },
123446
- "allow_deletions_enforcement_level": {
123447
- "type": "string",
123448
- "enum": [
123449
- "off",
123450
- "non_admins",
123451
- "everyone"
123452
- ]
123453
- },
123454
- "allow_force_pushes_enforcement_level": {
123455
- "type": "string",
123456
- "enum": [
123457
- "off",
123458
- "non_admins",
123459
- "everyone"
123460
- ]
123461
- },
123462
- "authorized_actor_names": {
123463
- "type": "array",
123464
- "items": {
123465
- "type": "string"
123466
- }
123467
- },
123468
- "authorized_actors_only": {
123469
- "type": "boolean"
123470
- },
123471
- "authorized_dismissal_actors_only": {
123472
- "type": "boolean"
123473
- },
123474
- "create_protected": {
123475
- "type": "boolean"
123476
- },
123477
- "created_at": {
123478
- "type": "string",
123479
- "format": "date-time"
123480
- },
123481
- "dismiss_stale_reviews_on_push": {
123482
- "type": "boolean"
123483
- },
123484
- "id": {
123485
- "type": "integer"
123486
- },
123487
- "ignore_approvals_from_contributors": {
123488
- "type": "boolean"
123489
- },
123490
- "linear_history_requirement_enforcement_level": {
123491
- "type": "string",
123492
- "enum": [
123493
- "off",
123494
- "non_admins",
123495
- "everyone"
123496
- ]
123497
- },
123498
- "merge_queue_enforcement_level": {
123499
- "type": "string",
123500
- "enum": [
123501
- "off",
123502
- "non_admins",
123503
- "everyone"
123504
- ]
123505
- },
123506
- "name": {
123507
- "type": "string"
123508
- },
123509
- "pull_request_reviews_enforcement_level": {
123510
- "type": "string",
123511
- "enum": [
123512
- "off",
123513
- "non_admins",
123514
- "everyone"
123515
- ]
123516
- },
123517
- "repository_id": {
123518
- "type": "integer"
123519
- },
123520
- "require_code_owner_review": {
123521
- "type": "boolean"
123522
- },
123523
- "require_last_push_approval": {
123524
- "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
123525
- "type": "boolean"
123526
- },
123527
- "required_approving_review_count": {
123528
- "type": "integer"
123529
- },
123530
- "required_conversation_resolution_level": {
123531
- "type": "string",
123532
- "enum": [
123533
- "off",
123534
- "non_admins",
123535
- "everyone"
123536
- ]
123537
- },
123538
- "required_deployments_enforcement_level": {
123539
- "type": "string",
123540
- "enum": [
123541
- "off",
123542
- "non_admins",
123543
- "everyone"
123544
- ]
123545
- },
123546
- "required_status_checks": {
123547
- "type": "array",
123548
- "items": {
123549
- "type": "string"
123550
- }
123551
- },
123552
- "required_status_checks_enforcement_level": {
123553
- "type": "string",
123554
- "enum": [
123555
- "off",
123556
- "non_admins",
123557
- "everyone"
123558
- ]
123559
- },
123560
- "signature_requirement_enforcement_level": {
123561
- "type": "string",
123562
- "enum": [
123563
- "off",
123564
- "non_admins",
123565
- "everyone"
123566
- ]
123567
- },
123568
- "strict_required_status_checks_policy": {
123569
- "type": "boolean"
123570
- },
123571
- "updated_at": {
123572
- "type": "string",
123573
- "format": "date-time"
123574
- }
123575
- },
123576
- "required": [
123577
- "id",
123578
- "repository_id",
123579
- "name",
123580
- "created_at",
123581
- "updated_at",
123582
- "pull_request_reviews_enforcement_level",
123583
- "required_approving_review_count",
123584
- "dismiss_stale_reviews_on_push",
123585
- "require_code_owner_review",
123586
- "authorized_dismissal_actors_only",
123587
- "ignore_approvals_from_contributors",
123588
- "required_status_checks",
123589
- "required_status_checks_enforcement_level",
123590
- "strict_required_status_checks_policy",
123591
- "signature_requirement_enforcement_level",
123592
- "linear_history_requirement_enforcement_level",
123593
- "admin_enforced",
123594
- "allow_force_pushes_enforcement_level",
123595
- "allow_deletions_enforcement_level",
123596
- "merge_queue_enforcement_level",
123597
- "required_deployments_enforcement_level",
123598
- "required_conversation_resolution_level",
123599
- "authorized_actors_only",
123600
- "authorized_actor_names"
123601
- ]
123446
+ "$ref": "#/components/schemas/webhooks_rule"
123602
123447
  },
123603
123448
  "sender": {
123604
123449
  "$ref": "#/components/schemas/simple-user-webhooks"
@@ -123736,169 +123581,7 @@
123736
123581
  "$ref": "#/components/schemas/repository-webhooks"
123737
123582
  },
123738
123583
  "rule": {
123739
- "title": "branch protection rule",
123740
- "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/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.",
123741
- "type": "object",
123742
- "properties": {
123743
- "admin_enforced": {
123744
- "type": "boolean"
123745
- },
123746
- "allow_deletions_enforcement_level": {
123747
- "type": "string",
123748
- "enum": [
123749
- "off",
123750
- "non_admins",
123751
- "everyone"
123752
- ]
123753
- },
123754
- "allow_force_pushes_enforcement_level": {
123755
- "type": "string",
123756
- "enum": [
123757
- "off",
123758
- "non_admins",
123759
- "everyone"
123760
- ]
123761
- },
123762
- "authorized_actor_names": {
123763
- "type": "array",
123764
- "items": {
123765
- "type": "string"
123766
- }
123767
- },
123768
- "authorized_actors_only": {
123769
- "type": "boolean"
123770
- },
123771
- "authorized_dismissal_actors_only": {
123772
- "type": "boolean"
123773
- },
123774
- "create_protected": {
123775
- "type": "boolean"
123776
- },
123777
- "created_at": {
123778
- "type": "string",
123779
- "format": "date-time"
123780
- },
123781
- "dismiss_stale_reviews_on_push": {
123782
- "type": "boolean"
123783
- },
123784
- "id": {
123785
- "type": "integer"
123786
- },
123787
- "ignore_approvals_from_contributors": {
123788
- "type": "boolean"
123789
- },
123790
- "linear_history_requirement_enforcement_level": {
123791
- "type": "string",
123792
- "enum": [
123793
- "off",
123794
- "non_admins",
123795
- "everyone"
123796
- ]
123797
- },
123798
- "merge_queue_enforcement_level": {
123799
- "type": "string",
123800
- "enum": [
123801
- "off",
123802
- "non_admins",
123803
- "everyone"
123804
- ]
123805
- },
123806
- "name": {
123807
- "type": "string"
123808
- },
123809
- "pull_request_reviews_enforcement_level": {
123810
- "type": "string",
123811
- "enum": [
123812
- "off",
123813
- "non_admins",
123814
- "everyone"
123815
- ]
123816
- },
123817
- "repository_id": {
123818
- "type": "integer"
123819
- },
123820
- "require_code_owner_review": {
123821
- "type": "boolean"
123822
- },
123823
- "require_last_push_approval": {
123824
- "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
123825
- "type": "boolean"
123826
- },
123827
- "required_approving_review_count": {
123828
- "type": "integer"
123829
- },
123830
- "required_conversation_resolution_level": {
123831
- "type": "string",
123832
- "enum": [
123833
- "off",
123834
- "non_admins",
123835
- "everyone"
123836
- ]
123837
- },
123838
- "required_deployments_enforcement_level": {
123839
- "type": "string",
123840
- "enum": [
123841
- "off",
123842
- "non_admins",
123843
- "everyone"
123844
- ]
123845
- },
123846
- "required_status_checks": {
123847
- "type": "array",
123848
- "items": {
123849
- "type": "string"
123850
- }
123851
- },
123852
- "required_status_checks_enforcement_level": {
123853
- "type": "string",
123854
- "enum": [
123855
- "off",
123856
- "non_admins",
123857
- "everyone"
123858
- ]
123859
- },
123860
- "signature_requirement_enforcement_level": {
123861
- "type": "string",
123862
- "enum": [
123863
- "off",
123864
- "non_admins",
123865
- "everyone"
123866
- ]
123867
- },
123868
- "strict_required_status_checks_policy": {
123869
- "type": "boolean"
123870
- },
123871
- "updated_at": {
123872
- "type": "string",
123873
- "format": "date-time"
123874
- }
123875
- },
123876
- "required": [
123877
- "id",
123878
- "repository_id",
123879
- "name",
123880
- "created_at",
123881
- "updated_at",
123882
- "pull_request_reviews_enforcement_level",
123883
- "required_approving_review_count",
123884
- "dismiss_stale_reviews_on_push",
123885
- "require_code_owner_review",
123886
- "authorized_dismissal_actors_only",
123887
- "ignore_approvals_from_contributors",
123888
- "required_status_checks",
123889
- "required_status_checks_enforcement_level",
123890
- "strict_required_status_checks_policy",
123891
- "signature_requirement_enforcement_level",
123892
- "linear_history_requirement_enforcement_level",
123893
- "admin_enforced",
123894
- "allow_force_pushes_enforcement_level",
123895
- "allow_deletions_enforcement_level",
123896
- "merge_queue_enforcement_level",
123897
- "required_deployments_enforcement_level",
123898
- "required_conversation_resolution_level",
123899
- "authorized_actors_only",
123900
- "authorized_actor_names"
123901
- ]
123584
+ "$ref": "#/components/schemas/webhooks_rule"
123902
123585
  },
123903
123586
  "sender": {
123904
123587
  "$ref": "#/components/schemas/simple-user-webhooks"