@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": {
@@ -3585,7 +3585,7 @@
3585
3585
  "/app/installations/{installation_id}/access_tokens": {
3586
3586
  "post": {
3587
3587
  "summary": "Create an installation access token for an app",
3588
- "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.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
3588
+ "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.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
3589
3589
  "tags": [
3590
3590
  "apps"
3591
3591
  ],
@@ -15988,7 +15988,7 @@
15988
15988
  "/orgs/{org}/hooks": {
15989
15989
  "get": {
15990
15990
  "summary": "List organization webhooks",
15991
- "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.",
15991
+ "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.",
15992
15992
  "tags": [
15993
15993
  "orgs"
15994
15994
  ],
@@ -16046,7 +16046,7 @@
16046
16046
  },
16047
16047
  "post": {
16048
16048
  "summary": "Create an organization webhook",
16049
- "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.",
16049
+ "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.",
16050
16050
  "tags": [
16051
16051
  "orgs"
16052
16052
  ],
@@ -16183,7 +16183,7 @@
16183
16183
  "/orgs/{org}/hooks/{hook_id}": {
16184
16184
  "get": {
16185
16185
  "summary": "Get an organization webhook",
16186
- "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.",
16186
+ "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.",
16187
16187
  "tags": [
16188
16188
  "orgs"
16189
16189
  ],
@@ -16230,7 +16230,7 @@
16230
16230
  },
16231
16231
  "patch": {
16232
16232
  "summary": "Update an organization webhook",
16233
- "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.",
16233
+ "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.",
16234
16234
  "tags": [
16235
16235
  "orgs"
16236
16236
  ],
@@ -16342,7 +16342,7 @@
16342
16342
  },
16343
16343
  "delete": {
16344
16344
  "summary": "Delete an organization webhook",
16345
- "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.",
16345
+ "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.",
16346
16346
  "tags": [
16347
16347
  "orgs"
16348
16348
  ],
@@ -16379,7 +16379,7 @@
16379
16379
  "/orgs/{org}/hooks/{hook_id}/config": {
16380
16380
  "get": {
16381
16381
  "summary": "Get a webhook configuration for an organization",
16382
- "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.",
16382
+ "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.",
16383
16383
  "tags": [
16384
16384
  "orgs"
16385
16385
  ],
@@ -16423,7 +16423,7 @@
16423
16423
  },
16424
16424
  "patch": {
16425
16425
  "summary": "Update a webhook configuration for an organization",
16426
- "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.",
16426
+ "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.",
16427
16427
  "tags": [
16428
16428
  "orgs"
16429
16429
  ],
@@ -16504,7 +16504,7 @@
16504
16504
  "/orgs/{org}/hooks/{hook_id}/deliveries": {
16505
16505
  "get": {
16506
16506
  "summary": "List deliveries for an organization webhook",
16507
- "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.",
16507
+ "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.",
16508
16508
  "tags": [
16509
16509
  "orgs"
16510
16510
  ],
@@ -16573,7 +16573,7 @@
16573
16573
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
16574
16574
  "get": {
16575
16575
  "summary": "Get a webhook delivery for an organization webhook",
16576
- "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.",
16576
+ "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.",
16577
16577
  "tags": [
16578
16578
  "orgs"
16579
16579
  ],
@@ -16628,7 +16628,7 @@
16628
16628
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
16629
16629
  "post": {
16630
16630
  "summary": "Redeliver a delivery for an organization webhook",
16631
- "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.",
16631
+ "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.",
16632
16632
  "tags": [
16633
16633
  "orgs"
16634
16634
  ],
@@ -16671,7 +16671,7 @@
16671
16671
  "/orgs/{org}/hooks/{hook_id}/pings": {
16672
16672
  "post": {
16673
16673
  "summary": "Ping an organization webhook",
16674
- "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/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.",
16674
+ "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/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.",
16675
16675
  "tags": [
16676
16676
  "orgs"
16677
16677
  ],
@@ -115059,6 +115059,167 @@
115059
115059
  "updated_at"
115060
115060
  ]
115061
115061
  },
115062
+ "webhooks_rule": {
115063
+ "title": "branch protection rule",
115064
+ "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/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.",
115065
+ "type": "object",
115066
+ "properties": {
115067
+ "admin_enforced": {
115068
+ "type": "boolean"
115069
+ },
115070
+ "allow_deletions_enforcement_level": {
115071
+ "type": "string",
115072
+ "enum": [
115073
+ "off",
115074
+ "non_admins",
115075
+ "everyone"
115076
+ ]
115077
+ },
115078
+ "allow_force_pushes_enforcement_level": {
115079
+ "type": "string",
115080
+ "enum": [
115081
+ "off",
115082
+ "non_admins",
115083
+ "everyone"
115084
+ ]
115085
+ },
115086
+ "authorized_actor_names": {
115087
+ "type": "array",
115088
+ "items": {
115089
+ "type": "string"
115090
+ }
115091
+ },
115092
+ "authorized_actors_only": {
115093
+ "type": "boolean"
115094
+ },
115095
+ "authorized_dismissal_actors_only": {
115096
+ "type": "boolean"
115097
+ },
115098
+ "create_protected": {
115099
+ "type": "boolean"
115100
+ },
115101
+ "created_at": {
115102
+ "type": "string",
115103
+ "format": "date-time"
115104
+ },
115105
+ "dismiss_stale_reviews_on_push": {
115106
+ "type": "boolean"
115107
+ },
115108
+ "id": {
115109
+ "type": "integer"
115110
+ },
115111
+ "ignore_approvals_from_contributors": {
115112
+ "type": "boolean"
115113
+ },
115114
+ "linear_history_requirement_enforcement_level": {
115115
+ "type": "string",
115116
+ "enum": [
115117
+ "off",
115118
+ "non_admins",
115119
+ "everyone"
115120
+ ]
115121
+ },
115122
+ "merge_queue_enforcement_level": {
115123
+ "type": "string",
115124
+ "enum": [
115125
+ "off",
115126
+ "non_admins",
115127
+ "everyone"
115128
+ ]
115129
+ },
115130
+ "name": {
115131
+ "type": "string"
115132
+ },
115133
+ "pull_request_reviews_enforcement_level": {
115134
+ "type": "string",
115135
+ "enum": [
115136
+ "off",
115137
+ "non_admins",
115138
+ "everyone"
115139
+ ]
115140
+ },
115141
+ "repository_id": {
115142
+ "type": "integer"
115143
+ },
115144
+ "require_code_owner_review": {
115145
+ "type": "boolean"
115146
+ },
115147
+ "required_approving_review_count": {
115148
+ "type": "integer"
115149
+ },
115150
+ "required_conversation_resolution_level": {
115151
+ "type": "string",
115152
+ "enum": [
115153
+ "off",
115154
+ "non_admins",
115155
+ "everyone"
115156
+ ]
115157
+ },
115158
+ "required_deployments_enforcement_level": {
115159
+ "type": "string",
115160
+ "enum": [
115161
+ "off",
115162
+ "non_admins",
115163
+ "everyone"
115164
+ ]
115165
+ },
115166
+ "required_status_checks": {
115167
+ "type": "array",
115168
+ "items": {
115169
+ "type": "string"
115170
+ }
115171
+ },
115172
+ "required_status_checks_enforcement_level": {
115173
+ "type": "string",
115174
+ "enum": [
115175
+ "off",
115176
+ "non_admins",
115177
+ "everyone"
115178
+ ]
115179
+ },
115180
+ "signature_requirement_enforcement_level": {
115181
+ "type": "string",
115182
+ "enum": [
115183
+ "off",
115184
+ "non_admins",
115185
+ "everyone"
115186
+ ]
115187
+ },
115188
+ "strict_required_status_checks_policy": {
115189
+ "type": "boolean"
115190
+ },
115191
+ "updated_at": {
115192
+ "type": "string",
115193
+ "format": "date-time"
115194
+ }
115195
+ },
115196
+ "required": [
115197
+ "id",
115198
+ "repository_id",
115199
+ "name",
115200
+ "created_at",
115201
+ "updated_at",
115202
+ "pull_request_reviews_enforcement_level",
115203
+ "required_approving_review_count",
115204
+ "dismiss_stale_reviews_on_push",
115205
+ "require_code_owner_review",
115206
+ "authorized_dismissal_actors_only",
115207
+ "ignore_approvals_from_contributors",
115208
+ "required_status_checks",
115209
+ "required_status_checks_enforcement_level",
115210
+ "strict_required_status_checks_policy",
115211
+ "signature_requirement_enforcement_level",
115212
+ "linear_history_requirement_enforcement_level",
115213
+ "admin_enforced",
115214
+ "allow_force_pushes_enforcement_level",
115215
+ "allow_deletions_enforcement_level",
115216
+ "merge_queue_enforcement_level",
115217
+ "required_deployments_enforcement_level",
115218
+ "required_conversation_resolution_level",
115219
+ "authorized_actors_only",
115220
+ "authorized_actor_names"
115221
+ ]
115222
+ },
115062
115223
  "simple-user-webhooks": {
115063
115224
  "title": "Simple User",
115064
115225
  "description": "The GitHub user that triggered the event. This property is included in every webhook payload.",
@@ -117042,165 +117203,7 @@
117042
117203
  "$ref": "#/components/schemas/repository-webhooks"
117043
117204
  },
117044
117205
  "rule": {
117045
- "title": "branch protection rule",
117046
- "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/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.",
117047
- "type": "object",
117048
- "properties": {
117049
- "admin_enforced": {
117050
- "type": "boolean"
117051
- },
117052
- "allow_deletions_enforcement_level": {
117053
- "type": "string",
117054
- "enum": [
117055
- "off",
117056
- "non_admins",
117057
- "everyone"
117058
- ]
117059
- },
117060
- "allow_force_pushes_enforcement_level": {
117061
- "type": "string",
117062
- "enum": [
117063
- "off",
117064
- "non_admins",
117065
- "everyone"
117066
- ]
117067
- },
117068
- "authorized_actor_names": {
117069
- "type": "array",
117070
- "items": {
117071
- "type": "string"
117072
- }
117073
- },
117074
- "authorized_actors_only": {
117075
- "type": "boolean"
117076
- },
117077
- "authorized_dismissal_actors_only": {
117078
- "type": "boolean"
117079
- },
117080
- "create_protected": {
117081
- "type": "boolean"
117082
- },
117083
- "created_at": {
117084
- "type": "string",
117085
- "format": "date-time"
117086
- },
117087
- "dismiss_stale_reviews_on_push": {
117088
- "type": "boolean"
117089
- },
117090
- "id": {
117091
- "type": "integer"
117092
- },
117093
- "ignore_approvals_from_contributors": {
117094
- "type": "boolean"
117095
- },
117096
- "linear_history_requirement_enforcement_level": {
117097
- "type": "string",
117098
- "enum": [
117099
- "off",
117100
- "non_admins",
117101
- "everyone"
117102
- ]
117103
- },
117104
- "merge_queue_enforcement_level": {
117105
- "type": "string",
117106
- "enum": [
117107
- "off",
117108
- "non_admins",
117109
- "everyone"
117110
- ]
117111
- },
117112
- "name": {
117113
- "type": "string"
117114
- },
117115
- "pull_request_reviews_enforcement_level": {
117116
- "type": "string",
117117
- "enum": [
117118
- "off",
117119
- "non_admins",
117120
- "everyone"
117121
- ]
117122
- },
117123
- "repository_id": {
117124
- "type": "integer"
117125
- },
117126
- "require_code_owner_review": {
117127
- "type": "boolean"
117128
- },
117129
- "required_approving_review_count": {
117130
- "type": "integer"
117131
- },
117132
- "required_conversation_resolution_level": {
117133
- "type": "string",
117134
- "enum": [
117135
- "off",
117136
- "non_admins",
117137
- "everyone"
117138
- ]
117139
- },
117140
- "required_deployments_enforcement_level": {
117141
- "type": "string",
117142
- "enum": [
117143
- "off",
117144
- "non_admins",
117145
- "everyone"
117146
- ]
117147
- },
117148
- "required_status_checks": {
117149
- "type": "array",
117150
- "items": {
117151
- "type": "string"
117152
- }
117153
- },
117154
- "required_status_checks_enforcement_level": {
117155
- "type": "string",
117156
- "enum": [
117157
- "off",
117158
- "non_admins",
117159
- "everyone"
117160
- ]
117161
- },
117162
- "signature_requirement_enforcement_level": {
117163
- "type": "string",
117164
- "enum": [
117165
- "off",
117166
- "non_admins",
117167
- "everyone"
117168
- ]
117169
- },
117170
- "strict_required_status_checks_policy": {
117171
- "type": "boolean"
117172
- },
117173
- "updated_at": {
117174
- "type": "string",
117175
- "format": "date-time"
117176
- }
117177
- },
117178
- "required": [
117179
- "id",
117180
- "repository_id",
117181
- "name",
117182
- "created_at",
117183
- "updated_at",
117184
- "pull_request_reviews_enforcement_level",
117185
- "required_approving_review_count",
117186
- "dismiss_stale_reviews_on_push",
117187
- "require_code_owner_review",
117188
- "authorized_dismissal_actors_only",
117189
- "ignore_approvals_from_contributors",
117190
- "required_status_checks",
117191
- "required_status_checks_enforcement_level",
117192
- "strict_required_status_checks_policy",
117193
- "signature_requirement_enforcement_level",
117194
- "linear_history_requirement_enforcement_level",
117195
- "admin_enforced",
117196
- "allow_force_pushes_enforcement_level",
117197
- "allow_deletions_enforcement_level",
117198
- "merge_queue_enforcement_level",
117199
- "required_deployments_enforcement_level",
117200
- "required_conversation_resolution_level",
117201
- "authorized_actors_only",
117202
- "authorized_actor_names"
117203
- ]
117206
+ "$ref": "#/components/schemas/webhooks_rule"
117204
117207
  },
117205
117208
  "sender": {
117206
117209
  "$ref": "#/components/schemas/simple-user-webhooks"
@@ -117236,165 +117239,7 @@
117236
117239
  "$ref": "#/components/schemas/repository-webhooks"
117237
117240
  },
117238
117241
  "rule": {
117239
- "title": "branch protection rule",
117240
- "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/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.",
117241
- "type": "object",
117242
- "properties": {
117243
- "admin_enforced": {
117244
- "type": "boolean"
117245
- },
117246
- "allow_deletions_enforcement_level": {
117247
- "type": "string",
117248
- "enum": [
117249
- "off",
117250
- "non_admins",
117251
- "everyone"
117252
- ]
117253
- },
117254
- "allow_force_pushes_enforcement_level": {
117255
- "type": "string",
117256
- "enum": [
117257
- "off",
117258
- "non_admins",
117259
- "everyone"
117260
- ]
117261
- },
117262
- "authorized_actor_names": {
117263
- "type": "array",
117264
- "items": {
117265
- "type": "string"
117266
- }
117267
- },
117268
- "authorized_actors_only": {
117269
- "type": "boolean"
117270
- },
117271
- "authorized_dismissal_actors_only": {
117272
- "type": "boolean"
117273
- },
117274
- "create_protected": {
117275
- "type": "boolean"
117276
- },
117277
- "created_at": {
117278
- "type": "string",
117279
- "format": "date-time"
117280
- },
117281
- "dismiss_stale_reviews_on_push": {
117282
- "type": "boolean"
117283
- },
117284
- "id": {
117285
- "type": "integer"
117286
- },
117287
- "ignore_approvals_from_contributors": {
117288
- "type": "boolean"
117289
- },
117290
- "linear_history_requirement_enforcement_level": {
117291
- "type": "string",
117292
- "enum": [
117293
- "off",
117294
- "non_admins",
117295
- "everyone"
117296
- ]
117297
- },
117298
- "merge_queue_enforcement_level": {
117299
- "type": "string",
117300
- "enum": [
117301
- "off",
117302
- "non_admins",
117303
- "everyone"
117304
- ]
117305
- },
117306
- "name": {
117307
- "type": "string"
117308
- },
117309
- "pull_request_reviews_enforcement_level": {
117310
- "type": "string",
117311
- "enum": [
117312
- "off",
117313
- "non_admins",
117314
- "everyone"
117315
- ]
117316
- },
117317
- "repository_id": {
117318
- "type": "integer"
117319
- },
117320
- "require_code_owner_review": {
117321
- "type": "boolean"
117322
- },
117323
- "required_approving_review_count": {
117324
- "type": "integer"
117325
- },
117326
- "required_conversation_resolution_level": {
117327
- "type": "string",
117328
- "enum": [
117329
- "off",
117330
- "non_admins",
117331
- "everyone"
117332
- ]
117333
- },
117334
- "required_deployments_enforcement_level": {
117335
- "type": "string",
117336
- "enum": [
117337
- "off",
117338
- "non_admins",
117339
- "everyone"
117340
- ]
117341
- },
117342
- "required_status_checks": {
117343
- "type": "array",
117344
- "items": {
117345
- "type": "string"
117346
- }
117347
- },
117348
- "required_status_checks_enforcement_level": {
117349
- "type": "string",
117350
- "enum": [
117351
- "off",
117352
- "non_admins",
117353
- "everyone"
117354
- ]
117355
- },
117356
- "signature_requirement_enforcement_level": {
117357
- "type": "string",
117358
- "enum": [
117359
- "off",
117360
- "non_admins",
117361
- "everyone"
117362
- ]
117363
- },
117364
- "strict_required_status_checks_policy": {
117365
- "type": "boolean"
117366
- },
117367
- "updated_at": {
117368
- "type": "string",
117369
- "format": "date-time"
117370
- }
117371
- },
117372
- "required": [
117373
- "id",
117374
- "repository_id",
117375
- "name",
117376
- "created_at",
117377
- "updated_at",
117378
- "pull_request_reviews_enforcement_level",
117379
- "required_approving_review_count",
117380
- "dismiss_stale_reviews_on_push",
117381
- "require_code_owner_review",
117382
- "authorized_dismissal_actors_only",
117383
- "ignore_approvals_from_contributors",
117384
- "required_status_checks",
117385
- "required_status_checks_enforcement_level",
117386
- "strict_required_status_checks_policy",
117387
- "signature_requirement_enforcement_level",
117388
- "linear_history_requirement_enforcement_level",
117389
- "admin_enforced",
117390
- "allow_force_pushes_enforcement_level",
117391
- "allow_deletions_enforcement_level",
117392
- "merge_queue_enforcement_level",
117393
- "required_deployments_enforcement_level",
117394
- "required_conversation_resolution_level",
117395
- "authorized_actors_only",
117396
- "authorized_actor_names"
117397
- ]
117242
+ "$ref": "#/components/schemas/webhooks_rule"
117398
117243
  },
117399
117244
  "sender": {
117400
117245
  "$ref": "#/components/schemas/simple-user-webhooks"
@@ -117532,165 +117377,7 @@
117532
117377
  "$ref": "#/components/schemas/repository-webhooks"
117533
117378
  },
117534
117379
  "rule": {
117535
- "title": "branch protection rule",
117536
- "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/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.",
117537
- "type": "object",
117538
- "properties": {
117539
- "admin_enforced": {
117540
- "type": "boolean"
117541
- },
117542
- "allow_deletions_enforcement_level": {
117543
- "type": "string",
117544
- "enum": [
117545
- "off",
117546
- "non_admins",
117547
- "everyone"
117548
- ]
117549
- },
117550
- "allow_force_pushes_enforcement_level": {
117551
- "type": "string",
117552
- "enum": [
117553
- "off",
117554
- "non_admins",
117555
- "everyone"
117556
- ]
117557
- },
117558
- "authorized_actor_names": {
117559
- "type": "array",
117560
- "items": {
117561
- "type": "string"
117562
- }
117563
- },
117564
- "authorized_actors_only": {
117565
- "type": "boolean"
117566
- },
117567
- "authorized_dismissal_actors_only": {
117568
- "type": "boolean"
117569
- },
117570
- "create_protected": {
117571
- "type": "boolean"
117572
- },
117573
- "created_at": {
117574
- "type": "string",
117575
- "format": "date-time"
117576
- },
117577
- "dismiss_stale_reviews_on_push": {
117578
- "type": "boolean"
117579
- },
117580
- "id": {
117581
- "type": "integer"
117582
- },
117583
- "ignore_approvals_from_contributors": {
117584
- "type": "boolean"
117585
- },
117586
- "linear_history_requirement_enforcement_level": {
117587
- "type": "string",
117588
- "enum": [
117589
- "off",
117590
- "non_admins",
117591
- "everyone"
117592
- ]
117593
- },
117594
- "merge_queue_enforcement_level": {
117595
- "type": "string",
117596
- "enum": [
117597
- "off",
117598
- "non_admins",
117599
- "everyone"
117600
- ]
117601
- },
117602
- "name": {
117603
- "type": "string"
117604
- },
117605
- "pull_request_reviews_enforcement_level": {
117606
- "type": "string",
117607
- "enum": [
117608
- "off",
117609
- "non_admins",
117610
- "everyone"
117611
- ]
117612
- },
117613
- "repository_id": {
117614
- "type": "integer"
117615
- },
117616
- "require_code_owner_review": {
117617
- "type": "boolean"
117618
- },
117619
- "required_approving_review_count": {
117620
- "type": "integer"
117621
- },
117622
- "required_conversation_resolution_level": {
117623
- "type": "string",
117624
- "enum": [
117625
- "off",
117626
- "non_admins",
117627
- "everyone"
117628
- ]
117629
- },
117630
- "required_deployments_enforcement_level": {
117631
- "type": "string",
117632
- "enum": [
117633
- "off",
117634
- "non_admins",
117635
- "everyone"
117636
- ]
117637
- },
117638
- "required_status_checks": {
117639
- "type": "array",
117640
- "items": {
117641
- "type": "string"
117642
- }
117643
- },
117644
- "required_status_checks_enforcement_level": {
117645
- "type": "string",
117646
- "enum": [
117647
- "off",
117648
- "non_admins",
117649
- "everyone"
117650
- ]
117651
- },
117652
- "signature_requirement_enforcement_level": {
117653
- "type": "string",
117654
- "enum": [
117655
- "off",
117656
- "non_admins",
117657
- "everyone"
117658
- ]
117659
- },
117660
- "strict_required_status_checks_policy": {
117661
- "type": "boolean"
117662
- },
117663
- "updated_at": {
117664
- "type": "string",
117665
- "format": "date-time"
117666
- }
117667
- },
117668
- "required": [
117669
- "id",
117670
- "repository_id",
117671
- "name",
117672
- "created_at",
117673
- "updated_at",
117674
- "pull_request_reviews_enforcement_level",
117675
- "required_approving_review_count",
117676
- "dismiss_stale_reviews_on_push",
117677
- "require_code_owner_review",
117678
- "authorized_dismissal_actors_only",
117679
- "ignore_approvals_from_contributors",
117680
- "required_status_checks",
117681
- "required_status_checks_enforcement_level",
117682
- "strict_required_status_checks_policy",
117683
- "signature_requirement_enforcement_level",
117684
- "linear_history_requirement_enforcement_level",
117685
- "admin_enforced",
117686
- "allow_force_pushes_enforcement_level",
117687
- "allow_deletions_enforcement_level",
117688
- "merge_queue_enforcement_level",
117689
- "required_deployments_enforcement_level",
117690
- "required_conversation_resolution_level",
117691
- "authorized_actors_only",
117692
- "authorized_actor_names"
117693
- ]
117380
+ "$ref": "#/components/schemas/webhooks_rule"
117694
117381
  },
117695
117382
  "sender": {
117696
117383
  "$ref": "#/components/schemas/simple-user-webhooks"