@octokit/openapi 14.0.0 → 15.0.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": "14.0.0",
4
+ "version": "15.0.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": {
@@ -273,21 +273,7 @@
273
273
  "in": "query",
274
274
  "description": "If specified, only advisories for these ecosystems will be returned.",
275
275
  "schema": {
276
- "type": "string",
277
- "enum": [
278
- "actions",
279
- "composer",
280
- "erlang",
281
- "go",
282
- "maven",
283
- "npm",
284
- "nuget",
285
- "other",
286
- "pip",
287
- "pub",
288
- "rubygems",
289
- "rust"
290
- ]
276
+ "$ref": "#/components/schemas/security-advisory-ecosystems"
291
277
  }
292
278
  },
293
279
  {
@@ -5222,6 +5208,10 @@
5222
5208
  "type": "boolean",
5223
5209
  "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\""
5224
5210
  },
5211
+ "advanced_security_enabled_new_user_namespace_repos": {
5212
+ "type": "boolean",
5213
+ "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\""
5214
+ },
5225
5215
  "dependabot_alerts_enabled_for_new_repositories": {
5226
5216
  "type": "boolean",
5227
5217
  "description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\""
@@ -5641,9 +5631,6 @@
5641
5631
  }
5642
5632
  }
5643
5633
  }
5644
- },
5645
- "403": {
5646
- "$ref": "#/components/responses/code_scanning_forbidden_read"
5647
5634
  }
5648
5635
  },
5649
5636
  "x-github": {
@@ -5845,7 +5832,7 @@
5845
5832
  "/feeds": {
5846
5833
  "get": {
5847
5834
  "summary": "Get feeds",
5848
- "description": "GitHub Enterprise Cloud provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub Enterprise Cloud global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
5835
+ "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Cloud global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
5849
5836
  "tags": [
5850
5837
  "activity"
5851
5838
  ],
@@ -8773,7 +8760,7 @@
8773
8760
  "/organizations": {
8774
8761
  "get": {
8775
8762
  "summary": "List organizations",
8776
- "description": "Lists all organizations, in the order that they were created on GitHub Enterprise Cloud.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
8763
+ "description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
8777
8764
  "tags": [
8778
8765
  "orgs"
8779
8766
  ],
@@ -13760,6 +13747,9 @@
13760
13747
  "404": {
13761
13748
  "$ref": "#/components/responses/not_found"
13762
13749
  },
13750
+ "422": {
13751
+ "description": "There is a problem with your account's associated payment method."
13752
+ },
13763
13753
  "500": {
13764
13754
  "$ref": "#/components/responses/internal_error"
13765
13755
  }
@@ -15832,7 +15822,7 @@
15832
15822
  "/orgs/{org}/hooks": {
15833
15823
  "get": {
15834
15824
  "summary": "List organization webhooks",
15835
- "description": "",
15825
+ "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission 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 webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
15836
15826
  "tags": [
15837
15827
  "orgs"
15838
15828
  ],
@@ -15890,7 +15880,7 @@
15890
15880
  },
15891
15881
  "post": {
15892
15882
  "summary": "Create an organization webhook",
15893
- "description": "Here's how you can create a hook that posts payloads in JSON format:",
15883
+ "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission 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 webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
15894
15884
  "tags": [
15895
15885
  "orgs"
15896
15886
  ],
@@ -16027,7 +16017,7 @@
16027
16017
  "/orgs/{org}/hooks/{hook_id}": {
16028
16018
  "get": {
16029
16019
  "summary": "Get an organization webhook",
16030
- "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\"",
16020
+ "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission 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 webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16031
16021
  "tags": [
16032
16022
  "orgs"
16033
16023
  ],
@@ -16074,7 +16064,7 @@
16074
16064
  },
16075
16065
  "patch": {
16076
16066
  "summary": "Update an organization webhook",
16077
- "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization).\"",
16067
+ "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission 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 webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16078
16068
  "tags": [
16079
16069
  "orgs"
16080
16070
  ],
@@ -16186,7 +16176,7 @@
16186
16176
  },
16187
16177
  "delete": {
16188
16178
  "summary": "Delete an organization webhook",
16189
- "description": "",
16179
+ "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission 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 webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16190
16180
  "tags": [
16191
16181
  "orgs"
16192
16182
  ],
@@ -16223,7 +16213,7 @@
16223
16213
  "/orgs/{org}/hooks/{hook_id}/config": {
16224
16214
  "get": {
16225
16215
  "summary": "Get a webhook configuration for an organization",
16226
- "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.",
16216
+ "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission 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 webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16227
16217
  "tags": [
16228
16218
  "orgs"
16229
16219
  ],
@@ -16267,7 +16257,7 @@
16267
16257
  },
16268
16258
  "patch": {
16269
16259
  "summary": "Update a webhook configuration for an organization",
16270
- "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.",
16260
+ "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission 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 webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16271
16261
  "tags": [
16272
16262
  "orgs"
16273
16263
  ],
@@ -16348,7 +16338,7 @@
16348
16338
  "/orgs/{org}/hooks/{hook_id}/deliveries": {
16349
16339
  "get": {
16350
16340
  "summary": "List deliveries for an organization webhook",
16351
- "description": "Returns a list of webhook deliveries for a webhook configured in an organization.",
16341
+ "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission 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 webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16352
16342
  "tags": [
16353
16343
  "orgs"
16354
16344
  ],
@@ -16417,7 +16407,7 @@
16417
16407
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
16418
16408
  "get": {
16419
16409
  "summary": "Get a webhook delivery for an organization webhook",
16420
- "description": "Returns a delivery for a webhook configured in an organization.",
16410
+ "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission 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 webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16421
16411
  "tags": [
16422
16412
  "orgs"
16423
16413
  ],
@@ -16472,7 +16462,7 @@
16472
16462
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
16473
16463
  "post": {
16474
16464
  "summary": "Redeliver a delivery for an organization webhook",
16475
- "description": "Redeliver a delivery for a webhook configured in an organization.",
16465
+ "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission 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 webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16476
16466
  "tags": [
16477
16467
  "orgs"
16478
16468
  ],
@@ -16515,7 +16505,7 @@
16515
16505
  "/orgs/{org}/hooks/{hook_id}/pings": {
16516
16506
  "post": {
16517
16507
  "summary": "Ping an organization webhook",
16518
- "description": "This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) to be sent to the hook.",
16508
+ "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission 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 webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16519
16509
  "tags": [
16520
16510
  "orgs"
16521
16511
  ],
@@ -22571,9 +22561,6 @@
22571
22561
  }
22572
22562
  }
22573
22563
  }
22574
- },
22575
- "403": {
22576
- "$ref": "#/components/responses/code_scanning_forbidden_read"
22577
22564
  }
22578
22565
  },
22579
22566
  "x-github": {
@@ -29307,7 +29294,7 @@
29307
29294
  "/repos/{owner}/{repo}/actions/runs": {
29308
29295
  "get": {
29309
29296
  "summary": "List workflow runs for a repository",
29310
- "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
29297
+ "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.",
29311
29298
  "tags": [
29312
29299
  "actions"
29313
29300
  ],
@@ -35346,11 +35333,14 @@
35346
35333
  },
35347
35334
  "status": {
35348
35335
  "type": "string",
35349
- "description": "The current status.",
35336
+ "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
35350
35337
  "enum": [
35351
35338
  "queued",
35352
35339
  "in_progress",
35353
- "completed"
35340
+ "completed",
35341
+ "waiting",
35342
+ "requested",
35343
+ "pending"
35354
35344
  ]
35355
35345
  },
35356
35346
  "conclusion": {
@@ -39029,6 +39019,9 @@
39029
39019
  }
39030
39020
  }
39031
39021
  },
39022
+ "409": {
39023
+ "$ref": "#/components/responses/conflict"
39024
+ },
39032
39025
  "422": {
39033
39026
  "$ref": "#/components/responses/validation_failed"
39034
39027
  }
@@ -39260,6 +39253,9 @@
39260
39253
  "$ref": "#/components/headers/link"
39261
39254
  }
39262
39255
  }
39256
+ },
39257
+ "409": {
39258
+ "$ref": "#/components/responses/conflict"
39263
39259
  }
39264
39260
  },
39265
39261
  "x-github": {
@@ -39319,6 +39315,9 @@
39319
39315
  "404": {
39320
39316
  "$ref": "#/components/responses/not_found"
39321
39317
  },
39318
+ "409": {
39319
+ "$ref": "#/components/responses/conflict"
39320
+ },
39322
39321
  "422": {
39323
39322
  "$ref": "#/components/responses/validation_failed"
39324
39323
  },
@@ -39702,7 +39701,7 @@
39702
39701
  "/repos/{owner}/{repo}/compare/{basehead}": {
39703
39702
  "get": {
39704
39703
  "summary": "Compare two commits",
39705
- "description": "Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
39704
+ "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
39706
39705
  "tags": [
39707
39706
  "repos"
39708
39707
  ],
@@ -41722,6 +41721,9 @@
41722
41721
  "204": {
41723
41722
  "description": "Response"
41724
41723
  },
41724
+ "404": {
41725
+ "$ref": "#/components/responses/not_found"
41726
+ },
41725
41727
  "422": {
41726
41728
  "$ref": "#/components/responses/validation_failed"
41727
41729
  }
@@ -42643,6 +42645,616 @@
42643
42645
  "x-octokit": {}
42644
42646
  }
42645
42647
  },
42648
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
42649
+ "get": {
42650
+ "summary": "List environment secrets",
42651
+ "description": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
42652
+ "tags": [
42653
+ "actions"
42654
+ ],
42655
+ "operationId": "actions/list-environment-secrets",
42656
+ "externalDocs": {
42657
+ "description": "API method documentation",
42658
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets"
42659
+ },
42660
+ "parameters": [
42661
+ {
42662
+ "$ref": "#/components/parameters/owner"
42663
+ },
42664
+ {
42665
+ "$ref": "#/components/parameters/repo"
42666
+ },
42667
+ {
42668
+ "$ref": "#/components/parameters/environment-name"
42669
+ },
42670
+ {
42671
+ "$ref": "#/components/parameters/per-page"
42672
+ },
42673
+ {
42674
+ "$ref": "#/components/parameters/page"
42675
+ }
42676
+ ],
42677
+ "responses": {
42678
+ "200": {
42679
+ "description": "Response",
42680
+ "content": {
42681
+ "application/json": {
42682
+ "schema": {
42683
+ "type": "object",
42684
+ "required": [
42685
+ "total_count",
42686
+ "secrets"
42687
+ ],
42688
+ "properties": {
42689
+ "total_count": {
42690
+ "type": "integer"
42691
+ },
42692
+ "secrets": {
42693
+ "type": "array",
42694
+ "items": {
42695
+ "$ref": "#/components/schemas/actions-secret"
42696
+ }
42697
+ }
42698
+ }
42699
+ },
42700
+ "examples": {
42701
+ "default": {
42702
+ "$ref": "#/components/examples/actions-secret-paginated"
42703
+ }
42704
+ }
42705
+ }
42706
+ },
42707
+ "headers": {
42708
+ "Link": {
42709
+ "$ref": "#/components/headers/link"
42710
+ }
42711
+ }
42712
+ }
42713
+ },
42714
+ "x-github": {
42715
+ "githubCloudOnly": false,
42716
+ "enabledForGitHubApps": true,
42717
+ "category": "actions",
42718
+ "subcategory": "secrets"
42719
+ },
42720
+ "x-octokit": {}
42721
+ }
42722
+ },
42723
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
42724
+ "get": {
42725
+ "summary": "Get an environment public key",
42726
+ "description": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
42727
+ "tags": [
42728
+ "actions"
42729
+ ],
42730
+ "operationId": "actions/get-environment-public-key",
42731
+ "externalDocs": {
42732
+ "description": "API method documentation",
42733
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key"
42734
+ },
42735
+ "parameters": [
42736
+ {
42737
+ "$ref": "#/components/parameters/owner"
42738
+ },
42739
+ {
42740
+ "$ref": "#/components/parameters/repo"
42741
+ },
42742
+ {
42743
+ "$ref": "#/components/parameters/environment-name"
42744
+ }
42745
+ ],
42746
+ "responses": {
42747
+ "200": {
42748
+ "description": "Response",
42749
+ "content": {
42750
+ "application/json": {
42751
+ "schema": {
42752
+ "$ref": "#/components/schemas/actions-public-key"
42753
+ },
42754
+ "examples": {
42755
+ "default": {
42756
+ "$ref": "#/components/examples/actions-public-key"
42757
+ }
42758
+ }
42759
+ }
42760
+ }
42761
+ }
42762
+ },
42763
+ "x-github": {
42764
+ "githubCloudOnly": false,
42765
+ "enabledForGitHubApps": true,
42766
+ "category": "actions",
42767
+ "subcategory": "secrets"
42768
+ },
42769
+ "x-octokit": {}
42770
+ }
42771
+ },
42772
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
42773
+ "get": {
42774
+ "summary": "Get an environment secret",
42775
+ "description": "Gets a single environment secret without revealing its encrypted value.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
42776
+ "tags": [
42777
+ "actions"
42778
+ ],
42779
+ "operationId": "actions/get-environment-secret",
42780
+ "externalDocs": {
42781
+ "description": "API method documentation",
42782
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret"
42783
+ },
42784
+ "parameters": [
42785
+ {
42786
+ "$ref": "#/components/parameters/owner"
42787
+ },
42788
+ {
42789
+ "$ref": "#/components/parameters/repo"
42790
+ },
42791
+ {
42792
+ "$ref": "#/components/parameters/environment-name"
42793
+ },
42794
+ {
42795
+ "$ref": "#/components/parameters/secret-name"
42796
+ }
42797
+ ],
42798
+ "responses": {
42799
+ "200": {
42800
+ "description": "Response",
42801
+ "content": {
42802
+ "application/json": {
42803
+ "schema": {
42804
+ "$ref": "#/components/schemas/actions-secret"
42805
+ },
42806
+ "examples": {
42807
+ "default": {
42808
+ "$ref": "#/components/examples/actions-secret"
42809
+ }
42810
+ }
42811
+ }
42812
+ }
42813
+ }
42814
+ },
42815
+ "x-github": {
42816
+ "githubCloudOnly": false,
42817
+ "enabledForGitHubApps": true,
42818
+ "category": "actions",
42819
+ "subcategory": "secrets"
42820
+ },
42821
+ "x-octokit": {}
42822
+ },
42823
+ "put": {
42824
+ "summary": "Create or update an environment secret",
42825
+ "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
42826
+ "tags": [
42827
+ "actions"
42828
+ ],
42829
+ "operationId": "actions/create-or-update-environment-secret",
42830
+ "externalDocs": {
42831
+ "description": "API method documentation",
42832
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret"
42833
+ },
42834
+ "parameters": [
42835
+ {
42836
+ "$ref": "#/components/parameters/owner"
42837
+ },
42838
+ {
42839
+ "$ref": "#/components/parameters/repo"
42840
+ },
42841
+ {
42842
+ "$ref": "#/components/parameters/environment-name"
42843
+ },
42844
+ {
42845
+ "$ref": "#/components/parameters/secret-name"
42846
+ }
42847
+ ],
42848
+ "requestBody": {
42849
+ "required": true,
42850
+ "content": {
42851
+ "application/json": {
42852
+ "schema": {
42853
+ "type": "object",
42854
+ "properties": {
42855
+ "encrypted_value": {
42856
+ "type": "string",
42857
+ "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key) endpoint.",
42858
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
42859
+ },
42860
+ "key_id": {
42861
+ "type": "string",
42862
+ "description": "ID of the key you used to encrypt the secret."
42863
+ }
42864
+ },
42865
+ "required": [
42866
+ "encrypted_value",
42867
+ "key_id"
42868
+ ]
42869
+ },
42870
+ "examples": {
42871
+ "default": {
42872
+ "value": {
42873
+ "encrypted_value": "c2VjcmV0",
42874
+ "key_id": "012345678912345678"
42875
+ }
42876
+ }
42877
+ }
42878
+ }
42879
+ }
42880
+ },
42881
+ "responses": {
42882
+ "201": {
42883
+ "description": "Response when creating a secret",
42884
+ "content": {
42885
+ "application/json": {
42886
+ "schema": {
42887
+ "$ref": "#/components/schemas/empty-object"
42888
+ },
42889
+ "examples": {
42890
+ "default": {
42891
+ "value": null
42892
+ }
42893
+ }
42894
+ }
42895
+ }
42896
+ },
42897
+ "204": {
42898
+ "description": "Response when updating a secret"
42899
+ }
42900
+ },
42901
+ "x-github": {
42902
+ "githubCloudOnly": false,
42903
+ "enabledForGitHubApps": true,
42904
+ "category": "actions",
42905
+ "subcategory": "secrets"
42906
+ },
42907
+ "x-octokit": {}
42908
+ },
42909
+ "delete": {
42910
+ "summary": "Delete an environment secret",
42911
+ "description": "Deletes a secret in an environment using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
42912
+ "tags": [
42913
+ "actions"
42914
+ ],
42915
+ "operationId": "actions/delete-environment-secret",
42916
+ "externalDocs": {
42917
+ "description": "API method documentation",
42918
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret"
42919
+ },
42920
+ "parameters": [
42921
+ {
42922
+ "$ref": "#/components/parameters/owner"
42923
+ },
42924
+ {
42925
+ "$ref": "#/components/parameters/repo"
42926
+ },
42927
+ {
42928
+ "$ref": "#/components/parameters/environment-name"
42929
+ },
42930
+ {
42931
+ "$ref": "#/components/parameters/secret-name"
42932
+ }
42933
+ ],
42934
+ "responses": {
42935
+ "204": {
42936
+ "description": "Default response"
42937
+ }
42938
+ },
42939
+ "x-github": {
42940
+ "githubCloudOnly": false,
42941
+ "enabledForGitHubApps": true,
42942
+ "category": "actions",
42943
+ "subcategory": "secrets"
42944
+ },
42945
+ "x-octokit": {}
42946
+ }
42947
+ },
42948
+ "/repos/{owner}/{repo}/environments/{environment_name}/variables": {
42949
+ "get": {
42950
+ "summary": "List environment variables",
42951
+ "description": "Lists all environment variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
42952
+ "tags": [
42953
+ "actions"
42954
+ ],
42955
+ "operationId": "actions/list-environment-variables",
42956
+ "externalDocs": {
42957
+ "description": "API method documentation",
42958
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables"
42959
+ },
42960
+ "parameters": [
42961
+ {
42962
+ "$ref": "#/components/parameters/owner"
42963
+ },
42964
+ {
42965
+ "$ref": "#/components/parameters/repo"
42966
+ },
42967
+ {
42968
+ "$ref": "#/components/parameters/environment-name"
42969
+ },
42970
+ {
42971
+ "$ref": "#/components/parameters/variables-per-page"
42972
+ },
42973
+ {
42974
+ "$ref": "#/components/parameters/page"
42975
+ }
42976
+ ],
42977
+ "responses": {
42978
+ "200": {
42979
+ "description": "Response",
42980
+ "content": {
42981
+ "application/json": {
42982
+ "schema": {
42983
+ "type": "object",
42984
+ "required": [
42985
+ "total_count",
42986
+ "variables"
42987
+ ],
42988
+ "properties": {
42989
+ "total_count": {
42990
+ "type": "integer"
42991
+ },
42992
+ "variables": {
42993
+ "type": "array",
42994
+ "items": {
42995
+ "$ref": "#/components/schemas/actions-variable"
42996
+ }
42997
+ }
42998
+ }
42999
+ },
43000
+ "examples": {
43001
+ "default": {
43002
+ "$ref": "#/components/examples/actions-variables-paginated"
43003
+ }
43004
+ }
43005
+ }
43006
+ },
43007
+ "headers": {
43008
+ "Link": {
43009
+ "$ref": "#/components/headers/link"
43010
+ }
43011
+ }
43012
+ }
43013
+ },
43014
+ "x-github": {
43015
+ "githubCloudOnly": false,
43016
+ "enabledForGitHubApps": true,
43017
+ "category": "actions",
43018
+ "subcategory": "variables"
43019
+ },
43020
+ "x-octokit": {}
43021
+ },
43022
+ "post": {
43023
+ "summary": "Create an environment variable",
43024
+ "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
43025
+ "tags": [
43026
+ "actions"
43027
+ ],
43028
+ "operationId": "actions/create-environment-variable",
43029
+ "externalDocs": {
43030
+ "description": "API method documentation",
43031
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable"
43032
+ },
43033
+ "parameters": [
43034
+ {
43035
+ "$ref": "#/components/parameters/owner"
43036
+ },
43037
+ {
43038
+ "$ref": "#/components/parameters/repo"
43039
+ },
43040
+ {
43041
+ "$ref": "#/components/parameters/environment-name"
43042
+ }
43043
+ ],
43044
+ "requestBody": {
43045
+ "required": true,
43046
+ "content": {
43047
+ "application/json": {
43048
+ "schema": {
43049
+ "type": "object",
43050
+ "properties": {
43051
+ "name": {
43052
+ "type": "string",
43053
+ "description": "The name of the variable."
43054
+ },
43055
+ "value": {
43056
+ "type": "string",
43057
+ "description": "The value of the variable."
43058
+ }
43059
+ },
43060
+ "required": [
43061
+ "name",
43062
+ "value"
43063
+ ]
43064
+ },
43065
+ "examples": {
43066
+ "default": {
43067
+ "value": {
43068
+ "name": "USERNAME",
43069
+ "value": "octocat"
43070
+ }
43071
+ }
43072
+ }
43073
+ }
43074
+ }
43075
+ },
43076
+ "responses": {
43077
+ "201": {
43078
+ "description": "Response",
43079
+ "content": {
43080
+ "application/json": {
43081
+ "schema": {
43082
+ "$ref": "#/components/schemas/empty-object"
43083
+ },
43084
+ "examples": {
43085
+ "default": {
43086
+ "value": null
43087
+ }
43088
+ }
43089
+ }
43090
+ }
43091
+ }
43092
+ },
43093
+ "x-github": {
43094
+ "githubCloudOnly": false,
43095
+ "enabledForGitHubApps": true,
43096
+ "category": "actions",
43097
+ "subcategory": "variables"
43098
+ },
43099
+ "x-octokit": {}
43100
+ }
43101
+ },
43102
+ "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
43103
+ "get": {
43104
+ "summary": "Get an environment variable",
43105
+ "description": "Gets a specific variable in an environment.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
43106
+ "tags": [
43107
+ "actions"
43108
+ ],
43109
+ "operationId": "actions/get-environment-variable",
43110
+ "externalDocs": {
43111
+ "description": "API method documentation",
43112
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable"
43113
+ },
43114
+ "parameters": [
43115
+ {
43116
+ "$ref": "#/components/parameters/owner"
43117
+ },
43118
+ {
43119
+ "$ref": "#/components/parameters/repo"
43120
+ },
43121
+ {
43122
+ "$ref": "#/components/parameters/environment-name"
43123
+ },
43124
+ {
43125
+ "$ref": "#/components/parameters/variable-name"
43126
+ }
43127
+ ],
43128
+ "responses": {
43129
+ "200": {
43130
+ "description": "Response",
43131
+ "content": {
43132
+ "application/json": {
43133
+ "schema": {
43134
+ "$ref": "#/components/schemas/actions-variable"
43135
+ },
43136
+ "examples": {
43137
+ "default": {
43138
+ "$ref": "#/components/examples/actions-variable"
43139
+ }
43140
+ }
43141
+ }
43142
+ }
43143
+ }
43144
+ },
43145
+ "x-github": {
43146
+ "githubCloudOnly": false,
43147
+ "enabledForGitHubApps": true,
43148
+ "category": "actions",
43149
+ "subcategory": "variables"
43150
+ },
43151
+ "x-octokit": {}
43152
+ },
43153
+ "patch": {
43154
+ "summary": "Update an environment variable",
43155
+ "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
43156
+ "tags": [
43157
+ "actions"
43158
+ ],
43159
+ "operationId": "actions/update-environment-variable",
43160
+ "externalDocs": {
43161
+ "description": "API method documentation",
43162
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable"
43163
+ },
43164
+ "parameters": [
43165
+ {
43166
+ "$ref": "#/components/parameters/owner"
43167
+ },
43168
+ {
43169
+ "$ref": "#/components/parameters/repo"
43170
+ },
43171
+ {
43172
+ "$ref": "#/components/parameters/variable-name"
43173
+ },
43174
+ {
43175
+ "$ref": "#/components/parameters/environment-name"
43176
+ }
43177
+ ],
43178
+ "requestBody": {
43179
+ "required": true,
43180
+ "content": {
43181
+ "application/json": {
43182
+ "schema": {
43183
+ "type": "object",
43184
+ "properties": {
43185
+ "name": {
43186
+ "type": "string",
43187
+ "description": "The name of the variable."
43188
+ },
43189
+ "value": {
43190
+ "type": "string",
43191
+ "description": "The value of the variable."
43192
+ }
43193
+ }
43194
+ },
43195
+ "examples": {
43196
+ "default": {
43197
+ "value": {
43198
+ "name": "USERNAME",
43199
+ "value": "octocat"
43200
+ }
43201
+ }
43202
+ }
43203
+ }
43204
+ }
43205
+ },
43206
+ "responses": {
43207
+ "204": {
43208
+ "description": "Response"
43209
+ }
43210
+ },
43211
+ "x-github": {
43212
+ "githubCloudOnly": false,
43213
+ "enabledForGitHubApps": true,
43214
+ "category": "actions",
43215
+ "subcategory": "variables"
43216
+ },
43217
+ "x-octokit": {}
43218
+ },
43219
+ "delete": {
43220
+ "summary": "Delete an environment variable",
43221
+ "description": "Deletes an environment variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
43222
+ "tags": [
43223
+ "actions"
43224
+ ],
43225
+ "operationId": "actions/delete-environment-variable",
43226
+ "externalDocs": {
43227
+ "description": "API method documentation",
43228
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable"
43229
+ },
43230
+ "parameters": [
43231
+ {
43232
+ "$ref": "#/components/parameters/owner"
43233
+ },
43234
+ {
43235
+ "$ref": "#/components/parameters/repo"
43236
+ },
43237
+ {
43238
+ "$ref": "#/components/parameters/variable-name"
43239
+ },
43240
+ {
43241
+ "$ref": "#/components/parameters/environment-name"
43242
+ }
43243
+ ],
43244
+ "responses": {
43245
+ "204": {
43246
+ "description": "Response"
43247
+ }
43248
+ },
43249
+ "x-github": {
43250
+ "githubCloudOnly": false,
43251
+ "enabledForGitHubApps": true,
43252
+ "category": "actions",
43253
+ "subcategory": "variables"
43254
+ },
43255
+ "x-octokit": {}
43256
+ }
43257
+ },
42646
43258
  "/repos/{owner}/{repo}/events": {
42647
43259
  "get": {
42648
43260
  "summary": "List repository events",
@@ -43015,6 +43627,9 @@
43015
43627
  "404": {
43016
43628
  "$ref": "#/components/responses/not_found"
43017
43629
  },
43630
+ "409": {
43631
+ "$ref": "#/components/responses/conflict"
43632
+ },
43018
43633
  "422": {
43019
43634
  "$ref": "#/components/responses/validation_failed"
43020
43635
  }
@@ -43169,6 +43784,9 @@
43169
43784
  "404": {
43170
43785
  "$ref": "#/components/responses/not_found"
43171
43786
  },
43787
+ "409": {
43788
+ "$ref": "#/components/responses/conflict"
43789
+ },
43172
43790
  "422": {
43173
43791
  "$ref": "#/components/responses/validation_failed"
43174
43792
  }
@@ -43223,6 +43841,9 @@
43223
43841
  },
43224
43842
  "404": {
43225
43843
  "$ref": "#/components/responses/not_found"
43844
+ },
43845
+ "409": {
43846
+ "$ref": "#/components/responses/conflict"
43226
43847
  }
43227
43848
  },
43228
43849
  "x-github": {
@@ -43254,7 +43875,7 @@
43254
43875
  "$ref": "#/components/parameters/repo"
43255
43876
  },
43256
43877
  {
43257
- "$ref": "#/components/parameters/commit-ref"
43878
+ "$ref": "#/components/parameters/git-ref-only"
43258
43879
  }
43259
43880
  ],
43260
43881
  "responses": {
@@ -43280,6 +43901,9 @@
43280
43901
  "$ref": "#/components/headers/link"
43281
43902
  }
43282
43903
  }
43904
+ },
43905
+ "409": {
43906
+ "$ref": "#/components/responses/conflict"
43283
43907
  }
43284
43908
  },
43285
43909
  "x-github": {
@@ -43311,7 +43935,7 @@
43311
43935
  "$ref": "#/components/parameters/repo"
43312
43936
  },
43313
43937
  {
43314
- "$ref": "#/components/parameters/commit-ref"
43938
+ "$ref": "#/components/parameters/git-ref-only"
43315
43939
  }
43316
43940
  ],
43317
43941
  "responses": {
@@ -43332,6 +43956,9 @@
43332
43956
  },
43333
43957
  "404": {
43334
43958
  "$ref": "#/components/responses/not_found"
43959
+ },
43960
+ "409": {
43961
+ "$ref": "#/components/responses/conflict"
43335
43962
  }
43336
43963
  },
43337
43964
  "x-github": {
@@ -43419,6 +44046,9 @@
43419
44046
  }
43420
44047
  }
43421
44048
  },
44049
+ "409": {
44050
+ "$ref": "#/components/responses/conflict"
44051
+ },
43422
44052
  "422": {
43423
44053
  "$ref": "#/components/responses/validation_failed"
43424
44054
  }
@@ -43435,7 +44065,7 @@
43435
44065
  "/repos/{owner}/{repo}/git/refs/{ref}": {
43436
44066
  "patch": {
43437
44067
  "summary": "Update a reference",
43438
- "description": "",
44068
+ "description": "Updates the provided reference to point to a new SHA. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
43439
44069
  "tags": [
43440
44070
  "git"
43441
44071
  ],
@@ -43452,15 +44082,7 @@
43452
44082
  "$ref": "#/components/parameters/repo"
43453
44083
  },
43454
44084
  {
43455
- "name": "ref",
43456
- "description": "The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
43457
- "in": "path",
43458
- "required": true,
43459
- "example": "heads/featureA",
43460
- "schema": {
43461
- "type": "string"
43462
- },
43463
- "x-multi-segment": true
44085
+ "$ref": "#/components/parameters/git-ref-only"
43464
44086
  }
43465
44087
  ],
43466
44088
  "requestBody": {
@@ -43511,6 +44133,9 @@
43511
44133
  }
43512
44134
  }
43513
44135
  },
44136
+ "409": {
44137
+ "$ref": "#/components/responses/conflict"
44138
+ },
43514
44139
  "422": {
43515
44140
  "$ref": "#/components/responses/validation_failed"
43516
44141
  }
@@ -43525,7 +44150,7 @@
43525
44150
  },
43526
44151
  "delete": {
43527
44152
  "summary": "Delete a reference",
43528
- "description": "",
44153
+ "description": "Deletes the provided reference.",
43529
44154
  "tags": [
43530
44155
  "git"
43531
44156
  ],
@@ -43542,13 +44167,16 @@
43542
44167
  "$ref": "#/components/parameters/repo"
43543
44168
  },
43544
44169
  {
43545
- "$ref": "#/components/parameters/commit-ref"
44170
+ "$ref": "#/components/parameters/git-ref-only"
43546
44171
  }
43547
44172
  ],
43548
44173
  "responses": {
43549
44174
  "204": {
43550
44175
  "description": "Response"
43551
44176
  },
44177
+ "409": {
44178
+ "$ref": "#/components/responses/conflict"
44179
+ },
43552
44180
  "422": {
43553
44181
  "$ref": "#/components/responses/validation_failed"
43554
44182
  }
@@ -43683,6 +44311,9 @@
43683
44311
  }
43684
44312
  }
43685
44313
  },
44314
+ "409": {
44315
+ "$ref": "#/components/responses/conflict"
44316
+ },
43686
44317
  "422": {
43687
44318
  "$ref": "#/components/responses/validation_failed"
43688
44319
  }
@@ -43742,6 +44373,9 @@
43742
44373
  },
43743
44374
  "404": {
43744
44375
  "$ref": "#/components/responses/not_found"
44376
+ },
44377
+ "409": {
44378
+ "$ref": "#/components/responses/conflict"
43745
44379
  }
43746
44380
  },
43747
44381
  "x-github": {
@@ -43879,6 +44513,9 @@
43879
44513
  "404": {
43880
44514
  "$ref": "#/components/responses/not_found"
43881
44515
  },
44516
+ "409": {
44517
+ "$ref": "#/components/responses/conflict"
44518
+ },
43882
44519
  "422": {
43883
44520
  "$ref": "#/components/responses/validation_failed"
43884
44521
  }
@@ -43953,6 +44590,9 @@
43953
44590
  "404": {
43954
44591
  "$ref": "#/components/responses/not_found"
43955
44592
  },
44593
+ "409": {
44594
+ "$ref": "#/components/responses/conflict"
44595
+ },
43956
44596
  "422": {
43957
44597
  "$ref": "#/components/responses/validation_failed"
43958
44598
  }
@@ -48889,6 +49529,9 @@
48889
49529
  },
48890
49530
  {
48891
49531
  "$ref": "#/components/parameters/repo"
49532
+ },
49533
+ {
49534
+ "$ref": "#/components/parameters/git-ref"
48892
49535
  }
48893
49536
  ],
48894
49537
  "responses": {
@@ -50529,6 +51172,64 @@
50529
51172
  }
50530
51173
  },
50531
51174
  "/repos/{owner}/{repo}/private-vulnerability-reporting": {
51175
+ "get": {
51176
+ "summary": "Check if private vulnerability reporting is enabled for a repository",
51177
+ "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".",
51178
+ "tags": [
51179
+ "repos"
51180
+ ],
51181
+ "operationId": "repos/check-private-vulnerability-reporting",
51182
+ "externalDocs": {
51183
+ "description": "API method documentation",
51184
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository"
51185
+ },
51186
+ "parameters": [
51187
+ {
51188
+ "$ref": "#/components/parameters/owner"
51189
+ },
51190
+ {
51191
+ "$ref": "#/components/parameters/repo"
51192
+ }
51193
+ ],
51194
+ "responses": {
51195
+ "200": {
51196
+ "description": "Private vulnerability reporting status",
51197
+ "content": {
51198
+ "application/json": {
51199
+ "schema": {
51200
+ "type": "object",
51201
+ "properties": {
51202
+ "enabled": {
51203
+ "type": "boolean",
51204
+ "description": "Whether or not private vulnerability reporting is enabled for the repository."
51205
+ }
51206
+ },
51207
+ "required": [
51208
+ "enabled"
51209
+ ]
51210
+ },
51211
+ "examples": {
51212
+ "default": {
51213
+ "value": {
51214
+ "enabled": true
51215
+ }
51216
+ }
51217
+ }
51218
+ }
51219
+ }
51220
+ },
51221
+ "422": {
51222
+ "$ref": "#/components/responses/bad_request"
51223
+ }
51224
+ },
51225
+ "x-github": {
51226
+ "githubCloudOnly": false,
51227
+ "enabledForGitHubApps": true,
51228
+ "category": "repos",
51229
+ "subcategory": "repos"
51230
+ },
51231
+ "x-octokit": {}
51232
+ },
50532
51233
  "put": {
50533
51234
  "summary": "Enable private vulnerability reporting for a repository",
50534
51235
  "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"",
@@ -51675,6 +52376,9 @@
51675
52376
  "404": {
51676
52377
  "$ref": "#/components/responses/not_found"
51677
52378
  },
52379
+ "406": {
52380
+ "$ref": "#/components/responses/unacceptable"
52381
+ },
51678
52382
  "500": {
51679
52383
  "$ref": "#/components/responses/internal_error"
51680
52384
  },
@@ -58249,590 +58953,10 @@
58249
58953
  "x-octokit": {}
58250
58954
  }
58251
58955
  },
58252
- "/repositories/{repository_id}/environments/{environment_name}/secrets": {
58253
- "get": {
58254
- "summary": "List environment secrets",
58255
- "description": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
58256
- "tags": [
58257
- "actions"
58258
- ],
58259
- "operationId": "actions/list-environment-secrets",
58260
- "externalDocs": {
58261
- "description": "API method documentation",
58262
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets"
58263
- },
58264
- "parameters": [
58265
- {
58266
- "$ref": "#/components/parameters/repository-id"
58267
- },
58268
- {
58269
- "$ref": "#/components/parameters/environment-name"
58270
- },
58271
- {
58272
- "$ref": "#/components/parameters/per-page"
58273
- },
58274
- {
58275
- "$ref": "#/components/parameters/page"
58276
- }
58277
- ],
58278
- "responses": {
58279
- "200": {
58280
- "description": "Response",
58281
- "content": {
58282
- "application/json": {
58283
- "schema": {
58284
- "type": "object",
58285
- "required": [
58286
- "total_count",
58287
- "secrets"
58288
- ],
58289
- "properties": {
58290
- "total_count": {
58291
- "type": "integer"
58292
- },
58293
- "secrets": {
58294
- "type": "array",
58295
- "items": {
58296
- "$ref": "#/components/schemas/actions-secret"
58297
- }
58298
- }
58299
- }
58300
- },
58301
- "examples": {
58302
- "default": {
58303
- "$ref": "#/components/examples/actions-secret-paginated"
58304
- }
58305
- }
58306
- }
58307
- },
58308
- "headers": {
58309
- "Link": {
58310
- "$ref": "#/components/headers/link"
58311
- }
58312
- }
58313
- }
58314
- },
58315
- "x-github": {
58316
- "githubCloudOnly": false,
58317
- "enabledForGitHubApps": true,
58318
- "category": "actions",
58319
- "subcategory": "secrets"
58320
- },
58321
- "x-octokit": {}
58322
- }
58323
- },
58324
- "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
58325
- "get": {
58326
- "summary": "Get an environment public key",
58327
- "description": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
58328
- "tags": [
58329
- "actions"
58330
- ],
58331
- "operationId": "actions/get-environment-public-key",
58332
- "externalDocs": {
58333
- "description": "API method documentation",
58334
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key"
58335
- },
58336
- "parameters": [
58337
- {
58338
- "$ref": "#/components/parameters/repository-id"
58339
- },
58340
- {
58341
- "$ref": "#/components/parameters/environment-name"
58342
- }
58343
- ],
58344
- "responses": {
58345
- "200": {
58346
- "description": "Response",
58347
- "content": {
58348
- "application/json": {
58349
- "schema": {
58350
- "$ref": "#/components/schemas/actions-public-key"
58351
- },
58352
- "examples": {
58353
- "default": {
58354
- "$ref": "#/components/examples/actions-public-key"
58355
- }
58356
- }
58357
- }
58358
- }
58359
- }
58360
- },
58361
- "x-github": {
58362
- "githubCloudOnly": false,
58363
- "enabledForGitHubApps": true,
58364
- "category": "actions",
58365
- "subcategory": "secrets"
58366
- },
58367
- "x-octokit": {}
58368
- }
58369
- },
58370
- "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
58371
- "get": {
58372
- "summary": "Get an environment secret",
58373
- "description": "Gets a single environment secret without revealing its encrypted value.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
58374
- "tags": [
58375
- "actions"
58376
- ],
58377
- "operationId": "actions/get-environment-secret",
58378
- "externalDocs": {
58379
- "description": "API method documentation",
58380
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret"
58381
- },
58382
- "parameters": [
58383
- {
58384
- "$ref": "#/components/parameters/repository-id"
58385
- },
58386
- {
58387
- "$ref": "#/components/parameters/environment-name"
58388
- },
58389
- {
58390
- "$ref": "#/components/parameters/secret-name"
58391
- }
58392
- ],
58393
- "responses": {
58394
- "200": {
58395
- "description": "Response",
58396
- "content": {
58397
- "application/json": {
58398
- "schema": {
58399
- "$ref": "#/components/schemas/actions-secret"
58400
- },
58401
- "examples": {
58402
- "default": {
58403
- "$ref": "#/components/examples/actions-secret"
58404
- }
58405
- }
58406
- }
58407
- }
58408
- }
58409
- },
58410
- "x-github": {
58411
- "githubCloudOnly": false,
58412
- "enabledForGitHubApps": true,
58413
- "category": "actions",
58414
- "subcategory": "secrets"
58415
- },
58416
- "x-octokit": {}
58417
- },
58418
- "put": {
58419
- "summary": "Create or update an environment secret",
58420
- "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
58421
- "tags": [
58422
- "actions"
58423
- ],
58424
- "operationId": "actions/create-or-update-environment-secret",
58425
- "externalDocs": {
58426
- "description": "API method documentation",
58427
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret"
58428
- },
58429
- "parameters": [
58430
- {
58431
- "$ref": "#/components/parameters/repository-id"
58432
- },
58433
- {
58434
- "$ref": "#/components/parameters/environment-name"
58435
- },
58436
- {
58437
- "$ref": "#/components/parameters/secret-name"
58438
- }
58439
- ],
58440
- "requestBody": {
58441
- "required": true,
58442
- "content": {
58443
- "application/json": {
58444
- "schema": {
58445
- "type": "object",
58446
- "properties": {
58447
- "encrypted_value": {
58448
- "type": "string",
58449
- "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key) endpoint.",
58450
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
58451
- },
58452
- "key_id": {
58453
- "type": "string",
58454
- "description": "ID of the key you used to encrypt the secret."
58455
- }
58456
- },
58457
- "required": [
58458
- "encrypted_value",
58459
- "key_id"
58460
- ]
58461
- },
58462
- "examples": {
58463
- "default": {
58464
- "value": {
58465
- "encrypted_value": "c2VjcmV0",
58466
- "key_id": "012345678912345678"
58467
- }
58468
- }
58469
- }
58470
- }
58471
- }
58472
- },
58473
- "responses": {
58474
- "201": {
58475
- "description": "Response when creating a secret",
58476
- "content": {
58477
- "application/json": {
58478
- "schema": {
58479
- "$ref": "#/components/schemas/empty-object"
58480
- },
58481
- "examples": {
58482
- "default": {
58483
- "value": null
58484
- }
58485
- }
58486
- }
58487
- }
58488
- },
58489
- "204": {
58490
- "description": "Response when updating a secret"
58491
- }
58492
- },
58493
- "x-github": {
58494
- "githubCloudOnly": false,
58495
- "enabledForGitHubApps": true,
58496
- "category": "actions",
58497
- "subcategory": "secrets"
58498
- },
58499
- "x-octokit": {}
58500
- },
58501
- "delete": {
58502
- "summary": "Delete an environment secret",
58503
- "description": "Deletes a secret in an environment using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
58504
- "tags": [
58505
- "actions"
58506
- ],
58507
- "operationId": "actions/delete-environment-secret",
58508
- "externalDocs": {
58509
- "description": "API method documentation",
58510
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret"
58511
- },
58512
- "parameters": [
58513
- {
58514
- "$ref": "#/components/parameters/repository-id"
58515
- },
58516
- {
58517
- "$ref": "#/components/parameters/environment-name"
58518
- },
58519
- {
58520
- "$ref": "#/components/parameters/secret-name"
58521
- }
58522
- ],
58523
- "responses": {
58524
- "204": {
58525
- "description": "Default response"
58526
- }
58527
- },
58528
- "x-github": {
58529
- "githubCloudOnly": false,
58530
- "enabledForGitHubApps": true,
58531
- "category": "actions",
58532
- "subcategory": "secrets"
58533
- },
58534
- "x-octokit": {}
58535
- }
58536
- },
58537
- "/repositories/{repository_id}/environments/{environment_name}/variables": {
58538
- "get": {
58539
- "summary": "List environment variables",
58540
- "description": "Lists all environment variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
58541
- "tags": [
58542
- "actions"
58543
- ],
58544
- "operationId": "actions/list-environment-variables",
58545
- "externalDocs": {
58546
- "description": "API method documentation",
58547
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables"
58548
- },
58549
- "parameters": [
58550
- {
58551
- "$ref": "#/components/parameters/repository-id"
58552
- },
58553
- {
58554
- "$ref": "#/components/parameters/environment-name"
58555
- },
58556
- {
58557
- "$ref": "#/components/parameters/variables-per-page"
58558
- },
58559
- {
58560
- "$ref": "#/components/parameters/page"
58561
- }
58562
- ],
58563
- "responses": {
58564
- "200": {
58565
- "description": "Response",
58566
- "content": {
58567
- "application/json": {
58568
- "schema": {
58569
- "type": "object",
58570
- "required": [
58571
- "total_count",
58572
- "variables"
58573
- ],
58574
- "properties": {
58575
- "total_count": {
58576
- "type": "integer"
58577
- },
58578
- "variables": {
58579
- "type": "array",
58580
- "items": {
58581
- "$ref": "#/components/schemas/actions-variable"
58582
- }
58583
- }
58584
- }
58585
- },
58586
- "examples": {
58587
- "default": {
58588
- "$ref": "#/components/examples/actions-variables-paginated"
58589
- }
58590
- }
58591
- }
58592
- },
58593
- "headers": {
58594
- "Link": {
58595
- "$ref": "#/components/headers/link"
58596
- }
58597
- }
58598
- }
58599
- },
58600
- "x-github": {
58601
- "githubCloudOnly": false,
58602
- "enabledForGitHubApps": true,
58603
- "category": "actions",
58604
- "subcategory": "variables"
58605
- },
58606
- "x-octokit": {}
58607
- },
58608
- "post": {
58609
- "summary": "Create an environment variable",
58610
- "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
58611
- "tags": [
58612
- "actions"
58613
- ],
58614
- "operationId": "actions/create-environment-variable",
58615
- "externalDocs": {
58616
- "description": "API method documentation",
58617
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable"
58618
- },
58619
- "parameters": [
58620
- {
58621
- "$ref": "#/components/parameters/repository-id"
58622
- },
58623
- {
58624
- "$ref": "#/components/parameters/environment-name"
58625
- }
58626
- ],
58627
- "requestBody": {
58628
- "required": true,
58629
- "content": {
58630
- "application/json": {
58631
- "schema": {
58632
- "type": "object",
58633
- "properties": {
58634
- "name": {
58635
- "type": "string",
58636
- "description": "The name of the variable."
58637
- },
58638
- "value": {
58639
- "type": "string",
58640
- "description": "The value of the variable."
58641
- }
58642
- },
58643
- "required": [
58644
- "name",
58645
- "value"
58646
- ]
58647
- },
58648
- "examples": {
58649
- "default": {
58650
- "value": {
58651
- "name": "USERNAME",
58652
- "value": "octocat"
58653
- }
58654
- }
58655
- }
58656
- }
58657
- }
58658
- },
58659
- "responses": {
58660
- "201": {
58661
- "description": "Response",
58662
- "content": {
58663
- "application/json": {
58664
- "schema": {
58665
- "$ref": "#/components/schemas/empty-object"
58666
- },
58667
- "examples": {
58668
- "default": {
58669
- "value": null
58670
- }
58671
- }
58672
- }
58673
- }
58674
- }
58675
- },
58676
- "x-github": {
58677
- "githubCloudOnly": false,
58678
- "enabledForGitHubApps": true,
58679
- "category": "actions",
58680
- "subcategory": "variables"
58681
- },
58682
- "x-octokit": {}
58683
- }
58684
- },
58685
- "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
58686
- "get": {
58687
- "summary": "Get an environment variable",
58688
- "description": "Gets a specific variable in an environment.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
58689
- "tags": [
58690
- "actions"
58691
- ],
58692
- "operationId": "actions/get-environment-variable",
58693
- "externalDocs": {
58694
- "description": "API method documentation",
58695
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable"
58696
- },
58697
- "parameters": [
58698
- {
58699
- "$ref": "#/components/parameters/repository-id"
58700
- },
58701
- {
58702
- "$ref": "#/components/parameters/environment-name"
58703
- },
58704
- {
58705
- "$ref": "#/components/parameters/variable-name"
58706
- }
58707
- ],
58708
- "responses": {
58709
- "200": {
58710
- "description": "Response",
58711
- "content": {
58712
- "application/json": {
58713
- "schema": {
58714
- "$ref": "#/components/schemas/actions-variable"
58715
- },
58716
- "examples": {
58717
- "default": {
58718
- "$ref": "#/components/examples/actions-variable"
58719
- }
58720
- }
58721
- }
58722
- }
58723
- }
58724
- },
58725
- "x-github": {
58726
- "githubCloudOnly": false,
58727
- "enabledForGitHubApps": true,
58728
- "category": "actions",
58729
- "subcategory": "variables"
58730
- },
58731
- "x-octokit": {}
58732
- },
58733
- "patch": {
58734
- "summary": "Update an environment variable",
58735
- "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
58736
- "tags": [
58737
- "actions"
58738
- ],
58739
- "operationId": "actions/update-environment-variable",
58740
- "externalDocs": {
58741
- "description": "API method documentation",
58742
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable"
58743
- },
58744
- "parameters": [
58745
- {
58746
- "$ref": "#/components/parameters/repository-id"
58747
- },
58748
- {
58749
- "$ref": "#/components/parameters/variable-name"
58750
- },
58751
- {
58752
- "$ref": "#/components/parameters/environment-name"
58753
- }
58754
- ],
58755
- "requestBody": {
58756
- "required": true,
58757
- "content": {
58758
- "application/json": {
58759
- "schema": {
58760
- "type": "object",
58761
- "properties": {
58762
- "name": {
58763
- "type": "string",
58764
- "description": "The name of the variable."
58765
- },
58766
- "value": {
58767
- "type": "string",
58768
- "description": "The value of the variable."
58769
- }
58770
- }
58771
- },
58772
- "examples": {
58773
- "default": {
58774
- "value": {
58775
- "name": "USERNAME",
58776
- "value": "octocat"
58777
- }
58778
- }
58779
- }
58780
- }
58781
- }
58782
- },
58783
- "responses": {
58784
- "204": {
58785
- "description": "Response"
58786
- }
58787
- },
58788
- "x-github": {
58789
- "githubCloudOnly": false,
58790
- "enabledForGitHubApps": true,
58791
- "category": "actions",
58792
- "subcategory": "variables"
58793
- },
58794
- "x-octokit": {}
58795
- },
58796
- "delete": {
58797
- "summary": "Delete an environment variable",
58798
- "description": "Deletes an environment variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
58799
- "tags": [
58800
- "actions"
58801
- ],
58802
- "operationId": "actions/delete-environment-variable",
58803
- "externalDocs": {
58804
- "description": "API method documentation",
58805
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable"
58806
- },
58807
- "parameters": [
58808
- {
58809
- "$ref": "#/components/parameters/repository-id"
58810
- },
58811
- {
58812
- "$ref": "#/components/parameters/variable-name"
58813
- },
58814
- {
58815
- "$ref": "#/components/parameters/environment-name"
58816
- }
58817
- ],
58818
- "responses": {
58819
- "204": {
58820
- "description": "Response"
58821
- }
58822
- },
58823
- "x-github": {
58824
- "githubCloudOnly": false,
58825
- "enabledForGitHubApps": true,
58826
- "category": "actions",
58827
- "subcategory": "variables"
58828
- },
58829
- "x-octokit": {}
58830
- }
58831
- },
58832
- "/scim/v2/Groups": {
58956
+ "/scim/v2/enterprises/{enterprise}/Groups": {
58833
58957
  "get": {
58834
58958
  "summary": "List provisioned SCIM groups for an enterprise",
58835
- "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.",
58959
+ "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.",
58836
58960
  "operationId": "enterprise-admin/list-provisioned-groups-enterprise",
58837
58961
  "tags": [
58838
58962
  "enterprise-admin",
@@ -58868,6 +58992,9 @@
58868
58992
  },
58869
58993
  {
58870
58994
  "$ref": "#/components/parameters/count"
58995
+ },
58996
+ {
58997
+ "$ref": "#/components/parameters/enterprise"
58871
58998
  }
58872
58999
  ],
58873
59000
  "responses": {
@@ -58912,7 +59039,7 @@
58912
59039
  },
58913
59040
  "post": {
58914
59041
  "summary": "Provision a SCIM enterprise group",
58915
- "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nWhen members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user.",
59042
+ "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nCreates a SCIM group for an enterprise.\n\nWhen members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user.",
58916
59043
  "operationId": "enterprise-admin/provision-enterprise-group",
58917
59044
  "tags": [
58918
59045
  "enterprise-admin"
@@ -58921,6 +59048,11 @@
58921
59048
  "description": "API method documentation",
58922
59049
  "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-group"
58923
59050
  },
59051
+ "parameters": [
59052
+ {
59053
+ "$ref": "#/components/parameters/enterprise"
59054
+ }
59055
+ ],
58924
59056
  "requestBody": {
58925
59057
  "required": true,
58926
59058
  "content": {
@@ -58986,10 +59118,10 @@
58986
59118
  "x-octokit": {}
58987
59119
  }
58988
59120
  },
58989
- "/scim/v2/Groups/{scim_group_id}": {
59121
+ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": {
58990
59122
  "get": {
58991
59123
  "summary": "Get SCIM provisioning information for an enterprise group",
58992
- "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nGets information about a SCIM group.",
59124
+ "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nGets information about a SCIM group.",
58993
59125
  "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group",
58994
59126
  "tags": [
58995
59127
  "enterprise-admin"
@@ -59004,6 +59136,9 @@
59004
59136
  },
59005
59137
  {
59006
59138
  "$ref": "#/components/parameters/excluded-attributes"
59139
+ },
59140
+ {
59141
+ "$ref": "#/components/parameters/enterprise"
59007
59142
  }
59008
59143
  ],
59009
59144
  "responses": {
@@ -59051,7 +59186,7 @@
59051
59186
  },
59052
59187
  "put": {
59053
59188
  "summary": "Set SCIM information for a provisioned enterprise group",
59054
- "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.",
59189
+ "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.",
59055
59190
  "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group",
59056
59191
  "tags": [
59057
59192
  "enterprise-admin"
@@ -59063,6 +59198,9 @@
59063
59198
  "parameters": [
59064
59199
  {
59065
59200
  "$ref": "#/components/parameters/scim-group-id"
59201
+ },
59202
+ {
59203
+ "$ref": "#/components/parameters/enterprise"
59066
59204
  }
59067
59205
  ],
59068
59206
  "requestBody": {
@@ -59158,7 +59296,7 @@
59158
59296
  },
59159
59297
  "patch": {
59160
59298
  "summary": "Update an attribute for a SCIM enterprise group",
59161
- "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships.\n\nYou can submit group memberships individually or in batches for improved efficiency.\n\n**Note**: Memberships are referenced via a local user id. Ensure users are created before referencing them here.",
59299
+ "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships.\n\nYou can submit group memberships individually or in batches for improved efficiency.\n\n**Note**: Memberships are referenced via a local user id. Ensure users are created before referencing them here.",
59162
59300
  "operationId": "enterprise-admin/update-attribute-for-enterprise-group",
59163
59301
  "tags": [
59164
59302
  "enterprise-admin"
@@ -59170,6 +59308,9 @@
59170
59308
  "parameters": [
59171
59309
  {
59172
59310
  "$ref": "#/components/parameters/scim-group-id"
59311
+ },
59312
+ {
59313
+ "$ref": "#/components/parameters/enterprise"
59173
59314
  }
59174
59315
  ],
59175
59316
  "requestBody": {
@@ -59275,7 +59416,7 @@
59275
59416
  },
59276
59417
  "delete": {
59277
59418
  "summary": "Delete a SCIM group from an enterprise",
59278
- "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nDeletes a SCIM group from an enterprise.",
59419
+ "description": "**Note:** SCIM provisioning using the REST API is in public beta and subject to change.\n\nDeletes a SCIM group from an enterprise.",
59279
59420
  "operationId": "enterprise-admin/delete-scim-group-from-enterprise",
59280
59421
  "tags": [
59281
59422
  "enterprise-admin"
@@ -59287,6 +59428,9 @@
59287
59428
  "parameters": [
59288
59429
  {
59289
59430
  "$ref": "#/components/parameters/scim-group-id"
59431
+ },
59432
+ {
59433
+ "$ref": "#/components/parameters/enterprise"
59290
59434
  }
59291
59435
  ],
59292
59436
  "responses": {
@@ -59321,10 +59465,10 @@
59321
59465
  "x-octokit": {}
59322
59466
  }
59323
59467
  },
59324
- "/scim/v2/Users": {
59468
+ "/scim/v2/enterprises/{enterprise}/Users": {
59325
59469
  "get": {
59326
59470
  "summary": "List SCIM provisioned identities for an enterprise",
59327
- "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.",
59471
+ "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.",
59328
59472
  "operationId": "enterprise-admin/list-provisioned-identities-enterprise",
59329
59473
  "tags": [
59330
59474
  "enterprise-admin"
@@ -59356,6 +59500,9 @@
59356
59500
  },
59357
59501
  {
59358
59502
  "$ref": "#/components/parameters/count"
59503
+ },
59504
+ {
59505
+ "$ref": "#/components/parameters/enterprise"
59359
59506
  }
59360
59507
  ],
59361
59508
  "responses": {
@@ -59400,7 +59547,7 @@
59400
59547
  },
59401
59548
  "post": {
59402
59549
  "summary": "Provision a SCIM enterprise user",
59403
- "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.",
59550
+ "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.",
59404
59551
  "operationId": "enterprise-admin/provision-enterprise-user",
59405
59552
  "tags": [
59406
59553
  "enterprise-admin"
@@ -59409,6 +59556,11 @@
59409
59556
  "description": "API method documentation",
59410
59557
  "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-user"
59411
59558
  },
59559
+ "parameters": [
59560
+ {
59561
+ "$ref": "#/components/parameters/enterprise"
59562
+ }
59563
+ ],
59412
59564
  "requestBody": {
59413
59565
  "required": true,
59414
59566
  "content": {
@@ -59474,10 +59626,10 @@
59474
59626
  "x-octokit": {}
59475
59627
  }
59476
59628
  },
59477
- "/scim/v2/Users/{scim_user_id}": {
59629
+ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": {
59478
59630
  "get": {
59479
59631
  "summary": "Get SCIM provisioning information for an enterprise user",
59480
- "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nGets information about a SCIM user.",
59632
+ "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nGets information about a SCIM user.",
59481
59633
  "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-user",
59482
59634
  "tags": [
59483
59635
  "enterprise-admin"
@@ -59489,6 +59641,9 @@
59489
59641
  "parameters": [
59490
59642
  {
59491
59643
  "$ref": "#/components/parameters/scim-user-id"
59644
+ },
59645
+ {
59646
+ "$ref": "#/components/parameters/enterprise"
59492
59647
  }
59493
59648
  ],
59494
59649
  "responses": {
@@ -59536,7 +59691,7 @@
59536
59691
  },
59537
59692
  "put": {
59538
59693
  "summary": "Set SCIM information for a provisioned enterprise user",
59539
- "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint.\n\n**Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated.",
59694
+ "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint.\n\n**Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated.",
59540
59695
  "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-user",
59541
59696
  "tags": [
59542
59697
  "enterprise-admin"
@@ -59548,6 +59703,9 @@
59548
59703
  "parameters": [
59549
59704
  {
59550
59705
  "$ref": "#/components/parameters/scim-user-id"
59706
+ },
59707
+ {
59708
+ "$ref": "#/components/parameters/enterprise"
59551
59709
  }
59552
59710
  ],
59553
59711
  "requestBody": {
@@ -59613,7 +59771,7 @@
59613
59771
  },
59614
59772
  "patch": {
59615
59773
  "summary": "Update an attribute for a SCIM enterprise user",
59616
- "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will be ineffective.\n\n**Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated.\n\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```",
59774
+ "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will be ineffective.\n\n**Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated.\n\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```",
59617
59775
  "operationId": "enterprise-admin/update-attribute-for-enterprise-user",
59618
59776
  "tags": [
59619
59777
  "enterprise-admin"
@@ -59625,6 +59783,9 @@
59625
59783
  "parameters": [
59626
59784
  {
59627
59785
  "$ref": "#/components/parameters/scim-user-id"
59786
+ },
59787
+ {
59788
+ "$ref": "#/components/parameters/enterprise"
59628
59789
  }
59629
59790
  ],
59630
59791
  "requestBody": {
@@ -59748,7 +59909,7 @@
59748
59909
  },
59749
59910
  "delete": {
59750
59911
  "summary": "Delete a SCIM user from an enterprise",
59751
- "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nSuspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.",
59912
+ "description": "**Note:** SCIM provisioning using the REST API is in public beta and subject to change.\n\nSuspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.",
59752
59913
  "operationId": "enterprise-admin/delete-user-from-enterprise",
59753
59914
  "tags": [
59754
59915
  "enterprise-admin"
@@ -59760,6 +59921,9 @@
59760
59921
  "parameters": [
59761
59922
  {
59762
59923
  "$ref": "#/components/parameters/scim-user-id"
59924
+ },
59925
+ {
59926
+ "$ref": "#/components/parameters/enterprise"
59763
59927
  }
59764
59928
  ],
59765
59929
  "responses": {
@@ -70525,7 +70689,7 @@
70525
70689
  "/users/{username}/hovercard": {
70526
70690
  "get": {
70527
70691
  "summary": "Get contextual information for a user",
70528
- "description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:\n\n```shell\n curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n```\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
70692
+ "description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\n The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
70529
70693
  "tags": [
70530
70694
  "users"
70531
70695
  ],
@@ -90172,8 +90336,7 @@
90172
90336
  },
90173
90337
  "repository-dispatch-sample.collected": {
90174
90338
  "post": {
90175
- "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
90176
- "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.",
90339
+ "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
90177
90340
  "operationId": "repository-dispatch/sample.collected",
90178
90341
  "externalDocs": {
90179
90342
  "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch"
@@ -94780,7 +94943,8 @@
94780
94943
  },
94781
94944
  "hub_url": {
94782
94945
  "type": "string",
94783
- "format": "uri-template"
94946
+ "format": "uri-template",
94947
+ "deprecated": true
94784
94948
  },
94785
94949
  "issue_search_url": {
94786
94950
  "type": "string",
@@ -94876,7 +95040,6 @@
94876
95040
  "followers_url",
94877
95041
  "following_url",
94878
95042
  "gists_url",
94879
- "hub_url",
94880
95043
  "issue_search_url",
94881
95044
  "issues_url",
94882
95045
  "keys_url",
@@ -99562,6 +99725,11 @@
99562
99725
  "example": false,
99563
99726
  "description": "Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to\nthis enterprise."
99564
99727
  },
99728
+ "advanced_security_enabled_for_new_user_namespace_repositories": {
99729
+ "type": "boolean",
99730
+ "example": false,
99731
+ "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories."
99732
+ },
99565
99733
  "dependabot_alerts_enabled_for_new_repositories": {
99566
99734
  "type": "boolean",
99567
99735
  "example": false,
@@ -108405,6 +108573,43 @@
108405
108573
  }
108406
108574
  }
108407
108575
  },
108576
+ "repository-rule-params-code-scanning-threshold": {
108577
+ "title": "CodeScanningThreshold",
108578
+ "description": "A tool and its thresholds.",
108579
+ "type": "object",
108580
+ "properties": {
108581
+ "alerts": {
108582
+ "type": "string",
108583
+ "description": "Code scanning alert threshold",
108584
+ "enum": [
108585
+ "none",
108586
+ "errors",
108587
+ "errors_and_warnings",
108588
+ "all"
108589
+ ]
108590
+ },
108591
+ "security_alerts": {
108592
+ "type": "string",
108593
+ "description": "Code scanning security alert threshold.",
108594
+ "enum": [
108595
+ "none",
108596
+ "critical",
108597
+ "high_or_higher",
108598
+ "medium_or_higher",
108599
+ "all"
108600
+ ]
108601
+ },
108602
+ "tool": {
108603
+ "type": "string",
108604
+ "description": "The name of a code scanning tool"
108605
+ }
108606
+ },
108607
+ "required": [
108608
+ "alerts",
108609
+ "security_alerts",
108610
+ "tool"
108611
+ ]
108612
+ },
108408
108613
  "repository-rule": {
108409
108614
  "title": "Repository Rule",
108410
108615
  "type": "object",
@@ -110935,7 +111140,9 @@
110935
111140
  "queued",
110936
111141
  "in_progress",
110937
111142
  "completed",
110938
- "waiting"
111143
+ "waiting",
111144
+ "requested",
111145
+ "pending"
110939
111146
  ]
110940
111147
  },
110941
111148
  "conclusion": {
@@ -113624,13 +113831,16 @@
113624
113831
  "nullable": true
113625
113832
  },
113626
113833
  "status": {
113627
- "description": "The phase of the lifecycle that the check is currently in.",
113834
+ "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.",
113628
113835
  "example": "queued",
113629
113836
  "type": "string",
113630
113837
  "enum": [
113631
113838
  "queued",
113632
113839
  "in_progress",
113633
- "completed"
113840
+ "completed",
113841
+ "waiting",
113842
+ "requested",
113843
+ "pending"
113634
113844
  ]
113635
113845
  },
113636
113846
  "conclusion": {
@@ -113908,11 +114118,15 @@
113908
114118
  },
113909
114119
  "status": {
113910
114120
  "type": "string",
114121
+ "description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.",
113911
114122
  "example": "completed",
113912
114123
  "enum": [
113913
114124
  "queued",
113914
114125
  "in_progress",
113915
- "completed"
114126
+ "completed",
114127
+ "waiting",
114128
+ "requested",
114129
+ "pending"
113916
114130
  ],
113917
114131
  "nullable": true
113918
114132
  },
@@ -124044,6 +124258,64 @@
124044
124258
  "commit_url"
124045
124259
  ]
124046
124260
  },
124261
+ "secret-scanning-location-wiki-commit": {
124262
+ "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.",
124263
+ "type": "object",
124264
+ "properties": {
124265
+ "path": {
124266
+ "type": "string",
124267
+ "description": "The file path of the wiki page",
124268
+ "example": "/example/Home.md"
124269
+ },
124270
+ "start_line": {
124271
+ "type": "number",
124272
+ "description": "Line number at which the secret starts in the file"
124273
+ },
124274
+ "end_line": {
124275
+ "type": "number",
124276
+ "description": "Line number at which the secret ends in the file"
124277
+ },
124278
+ "start_column": {
124279
+ "type": "number",
124280
+ "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII."
124281
+ },
124282
+ "end_column": {
124283
+ "type": "number",
124284
+ "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII."
124285
+ },
124286
+ "blob_sha": {
124287
+ "type": "string",
124288
+ "description": "SHA-1 hash ID of the associated blob",
124289
+ "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b"
124290
+ },
124291
+ "page_url": {
124292
+ "type": "string",
124293
+ "description": "The GitHub URL to get the associated wiki page",
124294
+ "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
124295
+ },
124296
+ "commit_sha": {
124297
+ "type": "string",
124298
+ "description": "SHA-1 hash ID of the associated commit",
124299
+ "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5"
124300
+ },
124301
+ "commit_url": {
124302
+ "type": "string",
124303
+ "description": "The GitHub URL to get the associated wiki commit",
124304
+ "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
124305
+ }
124306
+ },
124307
+ "required": [
124308
+ "path",
124309
+ "start_line",
124310
+ "end_line",
124311
+ "start_column",
124312
+ "end_column",
124313
+ "blob_sha",
124314
+ "page_url",
124315
+ "commit_sha",
124316
+ "commit_url"
124317
+ ]
124318
+ },
124047
124319
  "secret-scanning-location-issue-title": {
124048
124320
  "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.",
124049
124321
  "type": "object",
@@ -124216,6 +124488,7 @@
124216
124488
  "type": "string",
124217
124489
  "enum": [
124218
124490
  "commit",
124491
+ "wiki_commit",
124219
124492
  "issue_title",
124220
124493
  "issue_body",
124221
124494
  "issue_comment",
@@ -124236,6 +124509,9 @@
124236
124509
  {
124237
124510
  "$ref": "#/components/schemas/secret-scanning-location-commit"
124238
124511
  },
124512
+ {
124513
+ "$ref": "#/components/schemas/secret-scanning-location-wiki-commit"
124514
+ },
124239
124515
  {
124240
124516
  "$ref": "#/components/schemas/secret-scanning-location-issue-title"
124241
124517
  },
@@ -124271,11 +124547,7 @@
124271
124547
  }
124272
124548
  ]
124273
124549
  }
124274
- },
124275
- "required": [
124276
- "type",
124277
- "details"
124278
- ]
124550
+ }
124279
124551
  },
124280
124552
  "repository-advisory-create": {
124281
124553
  "type": "object",
@@ -181486,6 +181758,7 @@
181486
181758
  "type": "object",
181487
181759
  "properties": {
181488
181760
  "permission": {
181761
+ "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.",
181489
181762
  "type": "object",
181490
181763
  "properties": {
181491
181764
  "to": {
@@ -181500,6 +181773,18 @@
181500
181773
  "required": [
181501
181774
  "to"
181502
181775
  ]
181776
+ },
181777
+ "role_name": {
181778
+ "description": "The role assigned to the collaborator.",
181779
+ "type": "object",
181780
+ "properties": {
181781
+ "to": {
181782
+ "type": "string"
181783
+ }
181784
+ },
181785
+ "required": [
181786
+ "to"
181787
+ ]
181503
181788
  }
181504
181789
  }
181505
181790
  },
@@ -266249,7 +266534,7 @@
266249
266534
  "type": "string"
266250
266535
  },
266251
266536
  "commits": {
266252
- "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest//rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.",
266537
+ "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest//rest/commits) to fetch additional commits.",
266253
266538
  "type": "array",
266254
266539
  "items": {
266255
266540
  "title": "Commit",
@@ -272086,9 +272371,7 @@
272086
272371
  "properties": {
272087
272372
  "action": {
272088
272373
  "type": "string",
272089
- "enum": [
272090
- "sample.collected"
272091
- ]
272374
+ "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
272092
272375
  },
272093
272376
  "branch": {
272094
272377
  "type": "string"
@@ -272096,7 +272379,8 @@
272096
272379
  "client_payload": {
272097
272380
  "type": "object",
272098
272381
  "nullable": true,
272099
- "additionalProperties": true
272382
+ "additionalProperties": true,
272383
+ "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
272100
272384
  },
272101
272385
  "enterprise": {
272102
272386
  "$ref": "#/components/schemas/enterprise-webhooks"
@@ -311600,6 +311884,20 @@
311600
311884
  "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b"
311601
311885
  }
311602
311886
  },
311887
+ {
311888
+ "type": "wiki_commit",
311889
+ "details": {
311890
+ "path": "/example/Home.md",
311891
+ "start_line": 1,
311892
+ "end_line": 1,
311893
+ "start_column": 1,
311894
+ "end_column": 64,
311895
+ "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b",
311896
+ "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5",
311897
+ "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5",
311898
+ "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
311899
+ }
311900
+ },
311603
311901
  {
311604
311902
  "type": "issue_title",
311605
311903
  "details": {
@@ -318897,6 +319195,7 @@
318897
319195
  "type": "string",
318898
319196
  "enum": [
318899
319197
  "advanced_security",
319198
+ "advanced_security_user_namespace",
318900
319199
  "dependabot_alerts",
318901
319200
  "secret_scanning",
318902
319201
  "secret_scanning_push_protection"
@@ -319585,7 +319884,7 @@
319585
319884
  },
319586
319885
  "workflow-run-status": {
319587
319886
  "name": "status",
319588
- "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
319887
+ "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
319589
319888
  "in": "query",
319590
319889
  "required": false,
319591
319890
  "schema": {
@@ -319839,6 +320138,17 @@
319839
320138
  "type": "integer"
319840
320139
  }
319841
320140
  },
320141
+ "git-ref-only": {
320142
+ "name": "ref",
320143
+ "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
320144
+ "in": "path",
320145
+ "required": true,
320146
+ "example": "heads/feature-a",
320147
+ "schema": {
320148
+ "type": "string"
320149
+ },
320150
+ "x-multi-segment": true
320151
+ },
319842
320152
  "since-user": {
319843
320153
  "name": "since",
319844
320154
  "description": "A user ID. Only return users with an ID greater than this ID.",
@@ -320307,16 +320617,6 @@
320307
320617
  }
320308
320618
  }
320309
320619
  },
320310
- "code_scanning_forbidden_read": {
320311
- "description": "Response if GitHub Advanced Security is not enabled for this repository",
320312
- "content": {
320313
- "application/json": {
320314
- "schema": {
320315
- "$ref": "#/components/schemas/basic-error"
320316
- }
320317
- }
320318
- }
320319
- },
320320
320620
  "forbidden_gist": {
320321
320621
  "description": "Forbidden Gist",
320322
320622
  "content": {
@@ -320406,6 +320706,16 @@
320406
320706
  }
320407
320707
  }
320408
320708
  },
320709
+ "code_scanning_forbidden_read": {
320710
+ "description": "Response if GitHub Advanced Security is not enabled for this repository",
320711
+ "content": {
320712
+ "application/json": {
320713
+ "schema": {
320714
+ "$ref": "#/components/schemas/basic-error"
320715
+ }
320716
+ }
320717
+ }
320718
+ },
320409
320719
  "code_scanning_forbidden_write": {
320410
320720
  "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
320411
320721
  "content": {
@@ -320449,6 +320759,16 @@
320449
320759
  }
320450
320760
  }
320451
320761
  },
320762
+ "unacceptable": {
320763
+ "description": "Unacceptable",
320764
+ "content": {
320765
+ "application/json": {
320766
+ "schema": {
320767
+ "$ref": "#/components/schemas/basic-error"
320768
+ }
320769
+ }
320770
+ }
320771
+ },
320452
320772
  "scim_bad_request": {
320453
320773
  "description": "Bad request",
320454
320774
  "content": {