@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": {
@@ -2342,21 +2342,7 @@
2342
2342
  "in": "query",
2343
2343
  "description": "If specified, only advisories for these ecosystems will be returned.",
2344
2344
  "schema": {
2345
- "type": "string",
2346
- "enum": [
2347
- "actions",
2348
- "composer",
2349
- "erlang",
2350
- "go",
2351
- "maven",
2352
- "npm",
2353
- "nuget",
2354
- "other",
2355
- "pip",
2356
- "pub",
2357
- "rubygems",
2358
- "rust"
2359
- ]
2345
+ "$ref": "#/components/schemas/security-advisory-ecosystems"
2360
2346
  }
2361
2347
  },
2362
2348
  {
@@ -8407,7 +8393,6 @@
8407
8393
  "default": {
8408
8394
  "value": {
8409
8395
  "advanced_security_enabled_for_new_repositories": true,
8410
- "advanced_security_enabled_new_user_namespace_repos": true,
8411
8396
  "dependabot_alerts_enabled_for_new_repositories": true,
8412
8397
  "secret_scanning_enabled_for_new_repositories": true,
8413
8398
  "secret_scanning_push_protection_enabled_for_new_repositories": true,
@@ -8770,7 +8755,7 @@
8770
8755
  "/feeds": {
8771
8756
  "get": {
8772
8757
  "summary": "Get feeds",
8773
- "description": "GitHub Enterprise Server 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 Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.11/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 Server.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
8758
+ "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 Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.11/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 Server.\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-server@3.11/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-server@3.11/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
8774
8759
  "tags": [
8775
8760
  "activity"
8776
8761
  ],
@@ -11642,7 +11627,7 @@
11642
11627
  "/organizations": {
11643
11628
  "get": {
11644
11629
  "summary": "List organizations",
11645
- "description": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
11630
+ "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-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
11646
11631
  "tags": [
11647
11632
  "orgs"
11648
11633
  ],
@@ -16645,7 +16630,7 @@
16645
16630
  "/orgs/{org}/hooks": {
16646
16631
  "get": {
16647
16632
  "summary": "List organization webhooks",
16648
- "description": "",
16633
+ "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16649
16634
  "tags": [
16650
16635
  "orgs"
16651
16636
  ],
@@ -16703,7 +16688,7 @@
16703
16688
  },
16704
16689
  "post": {
16705
16690
  "summary": "Create an organization webhook",
16706
- "description": "Here's how you can create a hook that posts payloads in JSON format:",
16691
+ "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or \nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16707
16692
  "tags": [
16708
16693
  "orgs"
16709
16694
  ],
@@ -16840,7 +16825,7 @@
16840
16825
  "/orgs/{org}/hooks/{hook_id}": {
16841
16826
  "get": {
16842
16827
  "summary": "Get an organization webhook",
16843
- "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).\"",
16828
+ "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16844
16829
  "tags": [
16845
16830
  "orgs"
16846
16831
  ],
@@ -16887,7 +16872,7 @@
16887
16872
  },
16888
16873
  "patch": {
16889
16874
  "summary": "Update an organization webhook",
16890
- "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).\"",
16875
+ "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16891
16876
  "tags": [
16892
16877
  "orgs"
16893
16878
  ],
@@ -16999,7 +16984,7 @@
16999
16984
  },
17000
16985
  "delete": {
17001
16986
  "summary": "Delete an organization webhook",
17002
- "description": "",
16987
+ "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
17003
16988
  "tags": [
17004
16989
  "orgs"
17005
16990
  ],
@@ -17036,7 +17021,7 @@
17036
17021
  "/orgs/{org}/hooks/{hook_id}/config": {
17037
17022
  "get": {
17038
17023
  "summary": "Get a webhook configuration for an organization",
17039
- "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.",
17024
+ "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
17040
17025
  "tags": [
17041
17026
  "orgs"
17042
17027
  ],
@@ -17080,7 +17065,7 @@
17080
17065
  },
17081
17066
  "patch": {
17082
17067
  "summary": "Update a webhook configuration for an organization",
17083
- "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.",
17068
+ "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
17084
17069
  "tags": [
17085
17070
  "orgs"
17086
17071
  ],
@@ -17161,7 +17146,7 @@
17161
17146
  "/orgs/{org}/hooks/{hook_id}/deliveries": {
17162
17147
  "get": {
17163
17148
  "summary": "List deliveries for an organization webhook",
17164
- "description": "Returns a list of webhook deliveries for a webhook configured in an organization.",
17149
+ "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
17165
17150
  "tags": [
17166
17151
  "orgs"
17167
17152
  ],
@@ -17230,7 +17215,7 @@
17230
17215
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
17231
17216
  "get": {
17232
17217
  "summary": "Get a webhook delivery for an organization webhook",
17233
- "description": "Returns a delivery for a webhook configured in an organization.",
17218
+ "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
17234
17219
  "tags": [
17235
17220
  "orgs"
17236
17221
  ],
@@ -17285,7 +17270,7 @@
17285
17270
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
17286
17271
  "post": {
17287
17272
  "summary": "Redeliver a delivery for an organization webhook",
17288
- "description": "Redeliver a delivery for a webhook configured in an organization.",
17273
+ "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
17289
17274
  "tags": [
17290
17275
  "orgs"
17291
17276
  ],
@@ -17328,7 +17313,7 @@
17328
17313
  "/orgs/{org}/hooks/{hook_id}/pings": {
17329
17314
  "post": {
17330
17315
  "summary": "Ping an organization webhook",
17331
- "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) to be sent to the hook.",
17316
+ "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
17332
17317
  "tags": [
17333
17318
  "orgs"
17334
17319
  ],
@@ -27831,7 +27816,7 @@
27831
27816
  "/repos/{owner}/{repo}/actions/runs": {
27832
27817
  "get": {
27833
27818
  "summary": "List workflow runs for a repository",
27834
- "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-server@3.11/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.",
27819
+ "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-server@3.11/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`.",
27835
27820
  "tags": [
27836
27821
  "actions"
27837
27822
  ],
@@ -33601,11 +33586,14 @@
33601
33586
  },
33602
33587
  "status": {
33603
33588
  "type": "string",
33604
- "description": "The current status.",
33589
+ "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
33605
33590
  "enum": [
33606
33591
  "queued",
33607
33592
  "in_progress",
33608
- "completed"
33593
+ "completed",
33594
+ "waiting",
33595
+ "requested",
33596
+ "pending"
33609
33597
  ]
33610
33598
  },
33611
33599
  "conclusion": {
@@ -36260,6 +36248,9 @@
36260
36248
  }
36261
36249
  }
36262
36250
  },
36251
+ "409": {
36252
+ "$ref": "#/components/responses/conflict"
36253
+ },
36263
36254
  "422": {
36264
36255
  "$ref": "#/components/responses/validation_failed"
36265
36256
  }
@@ -36491,6 +36482,9 @@
36491
36482
  "$ref": "#/components/headers/link"
36492
36483
  }
36493
36484
  }
36485
+ },
36486
+ "409": {
36487
+ "$ref": "#/components/responses/conflict"
36494
36488
  }
36495
36489
  },
36496
36490
  "x-github": {
@@ -36550,6 +36544,9 @@
36550
36544
  "404": {
36551
36545
  "$ref": "#/components/responses/not_found"
36552
36546
  },
36547
+ "409": {
36548
+ "$ref": "#/components/responses/conflict"
36549
+ },
36553
36550
  "422": {
36554
36551
  "$ref": "#/components/responses/validation_failed"
36555
36552
  },
@@ -36887,7 +36884,7 @@
36887
36884
  "/repos/{owner}/{repo}/compare/{basehead}": {
36888
36885
  "get": {
36889
36886
  "summary": "Compare two commits",
36890
- "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-server@3.11/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-server@3.11/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-server@3.11/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. |",
36887
+ "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-server@3.11/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-server@3.11/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-server@3.11/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. |",
36891
36888
  "tags": [
36892
36889
  "repos"
36893
36890
  ],
@@ -38907,6 +38904,9 @@
38907
38904
  "204": {
38908
38905
  "description": "Response"
38909
38906
  },
38907
+ "404": {
38908
+ "$ref": "#/components/responses/not_found"
38909
+ },
38910
38910
  "422": {
38911
38911
  "$ref": "#/components/responses/validation_failed"
38912
38912
  }
@@ -39817,6 +39817,616 @@
39817
39817
  "x-octokit": {}
39818
39818
  }
39819
39819
  },
39820
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
39821
+ "get": {
39822
+ "summary": "List environment secrets",
39823
+ "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.",
39824
+ "tags": [
39825
+ "actions"
39826
+ ],
39827
+ "operationId": "actions/list-environment-secrets",
39828
+ "externalDocs": {
39829
+ "description": "API method documentation",
39830
+ "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#list-environment-secrets"
39831
+ },
39832
+ "parameters": [
39833
+ {
39834
+ "$ref": "#/components/parameters/owner"
39835
+ },
39836
+ {
39837
+ "$ref": "#/components/parameters/repo"
39838
+ },
39839
+ {
39840
+ "$ref": "#/components/parameters/environment-name"
39841
+ },
39842
+ {
39843
+ "$ref": "#/components/parameters/per-page"
39844
+ },
39845
+ {
39846
+ "$ref": "#/components/parameters/page"
39847
+ }
39848
+ ],
39849
+ "responses": {
39850
+ "200": {
39851
+ "description": "Response",
39852
+ "content": {
39853
+ "application/json": {
39854
+ "schema": {
39855
+ "type": "object",
39856
+ "required": [
39857
+ "total_count",
39858
+ "secrets"
39859
+ ],
39860
+ "properties": {
39861
+ "total_count": {
39862
+ "type": "integer"
39863
+ },
39864
+ "secrets": {
39865
+ "type": "array",
39866
+ "items": {
39867
+ "$ref": "#/components/schemas/actions-secret"
39868
+ }
39869
+ }
39870
+ }
39871
+ },
39872
+ "examples": {
39873
+ "default": {
39874
+ "$ref": "#/components/examples/actions-secret-paginated"
39875
+ }
39876
+ }
39877
+ }
39878
+ },
39879
+ "headers": {
39880
+ "Link": {
39881
+ "$ref": "#/components/headers/link"
39882
+ }
39883
+ }
39884
+ }
39885
+ },
39886
+ "x-github": {
39887
+ "githubCloudOnly": false,
39888
+ "enabledForGitHubApps": true,
39889
+ "category": "actions",
39890
+ "subcategory": "secrets"
39891
+ },
39892
+ "x-octokit": {}
39893
+ }
39894
+ },
39895
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
39896
+ "get": {
39897
+ "summary": "Get an environment public key",
39898
+ "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.",
39899
+ "tags": [
39900
+ "actions"
39901
+ ],
39902
+ "operationId": "actions/get-environment-public-key",
39903
+ "externalDocs": {
39904
+ "description": "API method documentation",
39905
+ "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-public-key"
39906
+ },
39907
+ "parameters": [
39908
+ {
39909
+ "$ref": "#/components/parameters/owner"
39910
+ },
39911
+ {
39912
+ "$ref": "#/components/parameters/repo"
39913
+ },
39914
+ {
39915
+ "$ref": "#/components/parameters/environment-name"
39916
+ }
39917
+ ],
39918
+ "responses": {
39919
+ "200": {
39920
+ "description": "Response",
39921
+ "content": {
39922
+ "application/json": {
39923
+ "schema": {
39924
+ "$ref": "#/components/schemas/actions-public-key"
39925
+ },
39926
+ "examples": {
39927
+ "default": {
39928
+ "$ref": "#/components/examples/actions-public-key"
39929
+ }
39930
+ }
39931
+ }
39932
+ }
39933
+ }
39934
+ },
39935
+ "x-github": {
39936
+ "githubCloudOnly": false,
39937
+ "enabledForGitHubApps": true,
39938
+ "category": "actions",
39939
+ "subcategory": "secrets"
39940
+ },
39941
+ "x-octokit": {}
39942
+ }
39943
+ },
39944
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
39945
+ "get": {
39946
+ "summary": "Get an environment secret",
39947
+ "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.",
39948
+ "tags": [
39949
+ "actions"
39950
+ ],
39951
+ "operationId": "actions/get-environment-secret",
39952
+ "externalDocs": {
39953
+ "description": "API method documentation",
39954
+ "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-secret"
39955
+ },
39956
+ "parameters": [
39957
+ {
39958
+ "$ref": "#/components/parameters/owner"
39959
+ },
39960
+ {
39961
+ "$ref": "#/components/parameters/repo"
39962
+ },
39963
+ {
39964
+ "$ref": "#/components/parameters/environment-name"
39965
+ },
39966
+ {
39967
+ "$ref": "#/components/parameters/secret-name"
39968
+ }
39969
+ ],
39970
+ "responses": {
39971
+ "200": {
39972
+ "description": "Response",
39973
+ "content": {
39974
+ "application/json": {
39975
+ "schema": {
39976
+ "$ref": "#/components/schemas/actions-secret"
39977
+ },
39978
+ "examples": {
39979
+ "default": {
39980
+ "$ref": "#/components/examples/actions-secret"
39981
+ }
39982
+ }
39983
+ }
39984
+ }
39985
+ }
39986
+ },
39987
+ "x-github": {
39988
+ "githubCloudOnly": false,
39989
+ "enabledForGitHubApps": true,
39990
+ "category": "actions",
39991
+ "subcategory": "secrets"
39992
+ },
39993
+ "x-octokit": {}
39994
+ },
39995
+ "put": {
39996
+ "summary": "Create or update an environment secret",
39997
+ "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-server@3.11/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.",
39998
+ "tags": [
39999
+ "actions"
40000
+ ],
40001
+ "operationId": "actions/create-or-update-environment-secret",
40002
+ "externalDocs": {
40003
+ "description": "API method documentation",
40004
+ "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-environment-secret"
40005
+ },
40006
+ "parameters": [
40007
+ {
40008
+ "$ref": "#/components/parameters/owner"
40009
+ },
40010
+ {
40011
+ "$ref": "#/components/parameters/repo"
40012
+ },
40013
+ {
40014
+ "$ref": "#/components/parameters/environment-name"
40015
+ },
40016
+ {
40017
+ "$ref": "#/components/parameters/secret-name"
40018
+ }
40019
+ ],
40020
+ "requestBody": {
40021
+ "required": true,
40022
+ "content": {
40023
+ "application/json": {
40024
+ "schema": {
40025
+ "type": "object",
40026
+ "properties": {
40027
+ "encrypted_value": {
40028
+ "type": "string",
40029
+ "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-server@3.11/rest/actions/secrets#get-an-environment-public-key) endpoint.",
40030
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
40031
+ },
40032
+ "key_id": {
40033
+ "type": "string",
40034
+ "description": "ID of the key you used to encrypt the secret."
40035
+ }
40036
+ },
40037
+ "required": [
40038
+ "encrypted_value",
40039
+ "key_id"
40040
+ ]
40041
+ },
40042
+ "examples": {
40043
+ "default": {
40044
+ "value": {
40045
+ "encrypted_value": "c2VjcmV0",
40046
+ "key_id": "012345678912345678"
40047
+ }
40048
+ }
40049
+ }
40050
+ }
40051
+ }
40052
+ },
40053
+ "responses": {
40054
+ "201": {
40055
+ "description": "Response when creating a secret",
40056
+ "content": {
40057
+ "application/json": {
40058
+ "schema": {
40059
+ "$ref": "#/components/schemas/empty-object"
40060
+ },
40061
+ "examples": {
40062
+ "default": {
40063
+ "value": null
40064
+ }
40065
+ }
40066
+ }
40067
+ }
40068
+ },
40069
+ "204": {
40070
+ "description": "Response when updating a secret"
40071
+ }
40072
+ },
40073
+ "x-github": {
40074
+ "githubCloudOnly": false,
40075
+ "enabledForGitHubApps": true,
40076
+ "category": "actions",
40077
+ "subcategory": "secrets"
40078
+ },
40079
+ "x-octokit": {}
40080
+ },
40081
+ "delete": {
40082
+ "summary": "Delete an environment secret",
40083
+ "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.",
40084
+ "tags": [
40085
+ "actions"
40086
+ ],
40087
+ "operationId": "actions/delete-environment-secret",
40088
+ "externalDocs": {
40089
+ "description": "API method documentation",
40090
+ "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#delete-an-environment-secret"
40091
+ },
40092
+ "parameters": [
40093
+ {
40094
+ "$ref": "#/components/parameters/owner"
40095
+ },
40096
+ {
40097
+ "$ref": "#/components/parameters/repo"
40098
+ },
40099
+ {
40100
+ "$ref": "#/components/parameters/environment-name"
40101
+ },
40102
+ {
40103
+ "$ref": "#/components/parameters/secret-name"
40104
+ }
40105
+ ],
40106
+ "responses": {
40107
+ "204": {
40108
+ "description": "Default response"
40109
+ }
40110
+ },
40111
+ "x-github": {
40112
+ "githubCloudOnly": false,
40113
+ "enabledForGitHubApps": true,
40114
+ "category": "actions",
40115
+ "subcategory": "secrets"
40116
+ },
40117
+ "x-octokit": {}
40118
+ }
40119
+ },
40120
+ "/repos/{owner}/{repo}/environments/{environment_name}/variables": {
40121
+ "get": {
40122
+ "summary": "List environment variables",
40123
+ "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.",
40124
+ "tags": [
40125
+ "actions"
40126
+ ],
40127
+ "operationId": "actions/list-environment-variables",
40128
+ "externalDocs": {
40129
+ "description": "API method documentation",
40130
+ "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#list-environment-variables"
40131
+ },
40132
+ "parameters": [
40133
+ {
40134
+ "$ref": "#/components/parameters/owner"
40135
+ },
40136
+ {
40137
+ "$ref": "#/components/parameters/repo"
40138
+ },
40139
+ {
40140
+ "$ref": "#/components/parameters/environment-name"
40141
+ },
40142
+ {
40143
+ "$ref": "#/components/parameters/variables-per-page"
40144
+ },
40145
+ {
40146
+ "$ref": "#/components/parameters/page"
40147
+ }
40148
+ ],
40149
+ "responses": {
40150
+ "200": {
40151
+ "description": "Response",
40152
+ "content": {
40153
+ "application/json": {
40154
+ "schema": {
40155
+ "type": "object",
40156
+ "required": [
40157
+ "total_count",
40158
+ "variables"
40159
+ ],
40160
+ "properties": {
40161
+ "total_count": {
40162
+ "type": "integer"
40163
+ },
40164
+ "variables": {
40165
+ "type": "array",
40166
+ "items": {
40167
+ "$ref": "#/components/schemas/actions-variable"
40168
+ }
40169
+ }
40170
+ }
40171
+ },
40172
+ "examples": {
40173
+ "default": {
40174
+ "$ref": "#/components/examples/actions-variables-paginated"
40175
+ }
40176
+ }
40177
+ }
40178
+ },
40179
+ "headers": {
40180
+ "Link": {
40181
+ "$ref": "#/components/headers/link"
40182
+ }
40183
+ }
40184
+ }
40185
+ },
40186
+ "x-github": {
40187
+ "githubCloudOnly": false,
40188
+ "enabledForGitHubApps": true,
40189
+ "category": "actions",
40190
+ "subcategory": "variables"
40191
+ },
40192
+ "x-octokit": {}
40193
+ },
40194
+ "post": {
40195
+ "summary": "Create an environment variable",
40196
+ "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.",
40197
+ "tags": [
40198
+ "actions"
40199
+ ],
40200
+ "operationId": "actions/create-environment-variable",
40201
+ "externalDocs": {
40202
+ "description": "API method documentation",
40203
+ "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#create-an-environment-variable"
40204
+ },
40205
+ "parameters": [
40206
+ {
40207
+ "$ref": "#/components/parameters/owner"
40208
+ },
40209
+ {
40210
+ "$ref": "#/components/parameters/repo"
40211
+ },
40212
+ {
40213
+ "$ref": "#/components/parameters/environment-name"
40214
+ }
40215
+ ],
40216
+ "requestBody": {
40217
+ "required": true,
40218
+ "content": {
40219
+ "application/json": {
40220
+ "schema": {
40221
+ "type": "object",
40222
+ "properties": {
40223
+ "name": {
40224
+ "type": "string",
40225
+ "description": "The name of the variable."
40226
+ },
40227
+ "value": {
40228
+ "type": "string",
40229
+ "description": "The value of the variable."
40230
+ }
40231
+ },
40232
+ "required": [
40233
+ "name",
40234
+ "value"
40235
+ ]
40236
+ },
40237
+ "examples": {
40238
+ "default": {
40239
+ "value": {
40240
+ "name": "USERNAME",
40241
+ "value": "octocat"
40242
+ }
40243
+ }
40244
+ }
40245
+ }
40246
+ }
40247
+ },
40248
+ "responses": {
40249
+ "201": {
40250
+ "description": "Response",
40251
+ "content": {
40252
+ "application/json": {
40253
+ "schema": {
40254
+ "$ref": "#/components/schemas/empty-object"
40255
+ },
40256
+ "examples": {
40257
+ "default": {
40258
+ "value": null
40259
+ }
40260
+ }
40261
+ }
40262
+ }
40263
+ }
40264
+ },
40265
+ "x-github": {
40266
+ "githubCloudOnly": false,
40267
+ "enabledForGitHubApps": true,
40268
+ "category": "actions",
40269
+ "subcategory": "variables"
40270
+ },
40271
+ "x-octokit": {}
40272
+ }
40273
+ },
40274
+ "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
40275
+ "get": {
40276
+ "summary": "Get an environment variable",
40277
+ "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.",
40278
+ "tags": [
40279
+ "actions"
40280
+ ],
40281
+ "operationId": "actions/get-environment-variable",
40282
+ "externalDocs": {
40283
+ "description": "API method documentation",
40284
+ "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#get-an-environment-variable"
40285
+ },
40286
+ "parameters": [
40287
+ {
40288
+ "$ref": "#/components/parameters/owner"
40289
+ },
40290
+ {
40291
+ "$ref": "#/components/parameters/repo"
40292
+ },
40293
+ {
40294
+ "$ref": "#/components/parameters/environment-name"
40295
+ },
40296
+ {
40297
+ "$ref": "#/components/parameters/variable-name"
40298
+ }
40299
+ ],
40300
+ "responses": {
40301
+ "200": {
40302
+ "description": "Response",
40303
+ "content": {
40304
+ "application/json": {
40305
+ "schema": {
40306
+ "$ref": "#/components/schemas/actions-variable"
40307
+ },
40308
+ "examples": {
40309
+ "default": {
40310
+ "$ref": "#/components/examples/actions-variable"
40311
+ }
40312
+ }
40313
+ }
40314
+ }
40315
+ }
40316
+ },
40317
+ "x-github": {
40318
+ "githubCloudOnly": false,
40319
+ "enabledForGitHubApps": true,
40320
+ "category": "actions",
40321
+ "subcategory": "variables"
40322
+ },
40323
+ "x-octokit": {}
40324
+ },
40325
+ "patch": {
40326
+ "summary": "Update an environment variable",
40327
+ "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.",
40328
+ "tags": [
40329
+ "actions"
40330
+ ],
40331
+ "operationId": "actions/update-environment-variable",
40332
+ "externalDocs": {
40333
+ "description": "API method documentation",
40334
+ "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#update-an-environment-variable"
40335
+ },
40336
+ "parameters": [
40337
+ {
40338
+ "$ref": "#/components/parameters/owner"
40339
+ },
40340
+ {
40341
+ "$ref": "#/components/parameters/repo"
40342
+ },
40343
+ {
40344
+ "$ref": "#/components/parameters/variable-name"
40345
+ },
40346
+ {
40347
+ "$ref": "#/components/parameters/environment-name"
40348
+ }
40349
+ ],
40350
+ "requestBody": {
40351
+ "required": true,
40352
+ "content": {
40353
+ "application/json": {
40354
+ "schema": {
40355
+ "type": "object",
40356
+ "properties": {
40357
+ "name": {
40358
+ "type": "string",
40359
+ "description": "The name of the variable."
40360
+ },
40361
+ "value": {
40362
+ "type": "string",
40363
+ "description": "The value of the variable."
40364
+ }
40365
+ }
40366
+ },
40367
+ "examples": {
40368
+ "default": {
40369
+ "value": {
40370
+ "name": "USERNAME",
40371
+ "value": "octocat"
40372
+ }
40373
+ }
40374
+ }
40375
+ }
40376
+ }
40377
+ },
40378
+ "responses": {
40379
+ "204": {
40380
+ "description": "Response"
40381
+ }
40382
+ },
40383
+ "x-github": {
40384
+ "githubCloudOnly": false,
40385
+ "enabledForGitHubApps": true,
40386
+ "category": "actions",
40387
+ "subcategory": "variables"
40388
+ },
40389
+ "x-octokit": {}
40390
+ },
40391
+ "delete": {
40392
+ "summary": "Delete an environment variable",
40393
+ "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.",
40394
+ "tags": [
40395
+ "actions"
40396
+ ],
40397
+ "operationId": "actions/delete-environment-variable",
40398
+ "externalDocs": {
40399
+ "description": "API method documentation",
40400
+ "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#delete-an-environment-variable"
40401
+ },
40402
+ "parameters": [
40403
+ {
40404
+ "$ref": "#/components/parameters/owner"
40405
+ },
40406
+ {
40407
+ "$ref": "#/components/parameters/repo"
40408
+ },
40409
+ {
40410
+ "$ref": "#/components/parameters/variable-name"
40411
+ },
40412
+ {
40413
+ "$ref": "#/components/parameters/environment-name"
40414
+ }
40415
+ ],
40416
+ "responses": {
40417
+ "204": {
40418
+ "description": "Response"
40419
+ }
40420
+ },
40421
+ "x-github": {
40422
+ "githubCloudOnly": false,
40423
+ "enabledForGitHubApps": true,
40424
+ "category": "actions",
40425
+ "subcategory": "variables"
40426
+ },
40427
+ "x-octokit": {}
40428
+ }
40429
+ },
39820
40430
  "/repos/{owner}/{repo}/events": {
39821
40431
  "get": {
39822
40432
  "summary": "List repository events",
@@ -40189,6 +40799,9 @@
40189
40799
  "404": {
40190
40800
  "$ref": "#/components/responses/not_found"
40191
40801
  },
40802
+ "409": {
40803
+ "$ref": "#/components/responses/conflict"
40804
+ },
40192
40805
  "422": {
40193
40806
  "$ref": "#/components/responses/validation_failed"
40194
40807
  }
@@ -40343,6 +40956,9 @@
40343
40956
  "404": {
40344
40957
  "$ref": "#/components/responses/not_found"
40345
40958
  },
40959
+ "409": {
40960
+ "$ref": "#/components/responses/conflict"
40961
+ },
40346
40962
  "422": {
40347
40963
  "$ref": "#/components/responses/validation_failed"
40348
40964
  }
@@ -40397,6 +41013,9 @@
40397
41013
  },
40398
41014
  "404": {
40399
41015
  "$ref": "#/components/responses/not_found"
41016
+ },
41017
+ "409": {
41018
+ "$ref": "#/components/responses/conflict"
40400
41019
  }
40401
41020
  },
40402
41021
  "x-github": {
@@ -40428,7 +41047,7 @@
40428
41047
  "$ref": "#/components/parameters/repo"
40429
41048
  },
40430
41049
  {
40431
- "$ref": "#/components/parameters/commit-ref"
41050
+ "$ref": "#/components/parameters/git-ref-only"
40432
41051
  }
40433
41052
  ],
40434
41053
  "responses": {
@@ -40454,6 +41073,9 @@
40454
41073
  "$ref": "#/components/headers/link"
40455
41074
  }
40456
41075
  }
41076
+ },
41077
+ "409": {
41078
+ "$ref": "#/components/responses/conflict"
40457
41079
  }
40458
41080
  },
40459
41081
  "x-github": {
@@ -40485,7 +41107,7 @@
40485
41107
  "$ref": "#/components/parameters/repo"
40486
41108
  },
40487
41109
  {
40488
- "$ref": "#/components/parameters/commit-ref"
41110
+ "$ref": "#/components/parameters/git-ref-only"
40489
41111
  }
40490
41112
  ],
40491
41113
  "responses": {
@@ -40506,6 +41128,9 @@
40506
41128
  },
40507
41129
  "404": {
40508
41130
  "$ref": "#/components/responses/not_found"
41131
+ },
41132
+ "409": {
41133
+ "$ref": "#/components/responses/conflict"
40509
41134
  }
40510
41135
  },
40511
41136
  "x-github": {
@@ -40593,6 +41218,9 @@
40593
41218
  }
40594
41219
  }
40595
41220
  },
41221
+ "409": {
41222
+ "$ref": "#/components/responses/conflict"
41223
+ },
40596
41224
  "422": {
40597
41225
  "$ref": "#/components/responses/validation_failed"
40598
41226
  }
@@ -40609,7 +41237,7 @@
40609
41237
  "/repos/{owner}/{repo}/git/refs/{ref}": {
40610
41238
  "patch": {
40611
41239
  "summary": "Update a reference",
40612
- "description": "",
41240
+ "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.",
40613
41241
  "tags": [
40614
41242
  "git"
40615
41243
  ],
@@ -40626,15 +41254,7 @@
40626
41254
  "$ref": "#/components/parameters/repo"
40627
41255
  },
40628
41256
  {
40629
- "name": "ref",
40630
- "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.",
40631
- "in": "path",
40632
- "required": true,
40633
- "example": "heads/featureA",
40634
- "schema": {
40635
- "type": "string"
40636
- },
40637
- "x-multi-segment": true
41257
+ "$ref": "#/components/parameters/git-ref-only"
40638
41258
  }
40639
41259
  ],
40640
41260
  "requestBody": {
@@ -40685,6 +41305,9 @@
40685
41305
  }
40686
41306
  }
40687
41307
  },
41308
+ "409": {
41309
+ "$ref": "#/components/responses/conflict"
41310
+ },
40688
41311
  "422": {
40689
41312
  "$ref": "#/components/responses/validation_failed"
40690
41313
  }
@@ -40699,7 +41322,7 @@
40699
41322
  },
40700
41323
  "delete": {
40701
41324
  "summary": "Delete a reference",
40702
- "description": "",
41325
+ "description": "Deletes the provided reference.",
40703
41326
  "tags": [
40704
41327
  "git"
40705
41328
  ],
@@ -40716,13 +41339,16 @@
40716
41339
  "$ref": "#/components/parameters/repo"
40717
41340
  },
40718
41341
  {
40719
- "$ref": "#/components/parameters/commit-ref"
41342
+ "$ref": "#/components/parameters/git-ref-only"
40720
41343
  }
40721
41344
  ],
40722
41345
  "responses": {
40723
41346
  "204": {
40724
41347
  "description": "Response"
40725
41348
  },
41349
+ "409": {
41350
+ "$ref": "#/components/responses/conflict"
41351
+ },
40726
41352
  "422": {
40727
41353
  "$ref": "#/components/responses/validation_failed"
40728
41354
  }
@@ -40857,6 +41483,9 @@
40857
41483
  }
40858
41484
  }
40859
41485
  },
41486
+ "409": {
41487
+ "$ref": "#/components/responses/conflict"
41488
+ },
40860
41489
  "422": {
40861
41490
  "$ref": "#/components/responses/validation_failed"
40862
41491
  }
@@ -40916,6 +41545,9 @@
40916
41545
  },
40917
41546
  "404": {
40918
41547
  "$ref": "#/components/responses/not_found"
41548
+ },
41549
+ "409": {
41550
+ "$ref": "#/components/responses/conflict"
40919
41551
  }
40920
41552
  },
40921
41553
  "x-github": {
@@ -41053,6 +41685,9 @@
41053
41685
  "404": {
41054
41686
  "$ref": "#/components/responses/not_found"
41055
41687
  },
41688
+ "409": {
41689
+ "$ref": "#/components/responses/conflict"
41690
+ },
41056
41691
  "422": {
41057
41692
  "$ref": "#/components/responses/validation_failed"
41058
41693
  }
@@ -41127,6 +41762,9 @@
41127
41762
  "404": {
41128
41763
  "$ref": "#/components/responses/not_found"
41129
41764
  },
41765
+ "409": {
41766
+ "$ref": "#/components/responses/conflict"
41767
+ },
41130
41768
  "422": {
41131
41769
  "$ref": "#/components/responses/validation_failed"
41132
41770
  }
@@ -47955,6 +48593,9 @@
47955
48593
  "404": {
47956
48594
  "$ref": "#/components/responses/not_found"
47957
48595
  },
48596
+ "406": {
48597
+ "$ref": "#/components/responses/unacceptable"
48598
+ },
47958
48599
  "500": {
47959
48600
  "$ref": "#/components/responses/internal_error"
47960
48601
  },
@@ -53512,587 +54153,7 @@
53512
54153
  "x-octokit": {}
53513
54154
  }
53514
54155
  },
53515
- "/repositories/{repository_id}/environments/{environment_name}/secrets": {
53516
- "get": {
53517
- "summary": "List environment secrets",
53518
- "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.",
53519
- "tags": [
53520
- "actions"
53521
- ],
53522
- "operationId": "actions/list-environment-secrets",
53523
- "externalDocs": {
53524
- "description": "API method documentation",
53525
- "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#list-environment-secrets"
53526
- },
53527
- "parameters": [
53528
- {
53529
- "$ref": "#/components/parameters/repository-id"
53530
- },
53531
- {
53532
- "$ref": "#/components/parameters/environment-name"
53533
- },
53534
- {
53535
- "$ref": "#/components/parameters/per-page"
53536
- },
53537
- {
53538
- "$ref": "#/components/parameters/page"
53539
- }
53540
- ],
53541
- "responses": {
53542
- "200": {
53543
- "description": "Response",
53544
- "content": {
53545
- "application/json": {
53546
- "schema": {
53547
- "type": "object",
53548
- "required": [
53549
- "total_count",
53550
- "secrets"
53551
- ],
53552
- "properties": {
53553
- "total_count": {
53554
- "type": "integer"
53555
- },
53556
- "secrets": {
53557
- "type": "array",
53558
- "items": {
53559
- "$ref": "#/components/schemas/actions-secret"
53560
- }
53561
- }
53562
- }
53563
- },
53564
- "examples": {
53565
- "default": {
53566
- "$ref": "#/components/examples/actions-secret-paginated"
53567
- }
53568
- }
53569
- }
53570
- },
53571
- "headers": {
53572
- "Link": {
53573
- "$ref": "#/components/headers/link"
53574
- }
53575
- }
53576
- }
53577
- },
53578
- "x-github": {
53579
- "githubCloudOnly": false,
53580
- "enabledForGitHubApps": true,
53581
- "category": "actions",
53582
- "subcategory": "secrets"
53583
- },
53584
- "x-octokit": {}
53585
- }
53586
- },
53587
- "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
53588
- "get": {
53589
- "summary": "Get an environment public key",
53590
- "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.",
53591
- "tags": [
53592
- "actions"
53593
- ],
53594
- "operationId": "actions/get-environment-public-key",
53595
- "externalDocs": {
53596
- "description": "API method documentation",
53597
- "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-public-key"
53598
- },
53599
- "parameters": [
53600
- {
53601
- "$ref": "#/components/parameters/repository-id"
53602
- },
53603
- {
53604
- "$ref": "#/components/parameters/environment-name"
53605
- }
53606
- ],
53607
- "responses": {
53608
- "200": {
53609
- "description": "Response",
53610
- "content": {
53611
- "application/json": {
53612
- "schema": {
53613
- "$ref": "#/components/schemas/actions-public-key"
53614
- },
53615
- "examples": {
53616
- "default": {
53617
- "$ref": "#/components/examples/actions-public-key"
53618
- }
53619
- }
53620
- }
53621
- }
53622
- }
53623
- },
53624
- "x-github": {
53625
- "githubCloudOnly": false,
53626
- "enabledForGitHubApps": true,
53627
- "category": "actions",
53628
- "subcategory": "secrets"
53629
- },
53630
- "x-octokit": {}
53631
- }
53632
- },
53633
- "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
53634
- "get": {
53635
- "summary": "Get an environment secret",
53636
- "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.",
53637
- "tags": [
53638
- "actions"
53639
- ],
53640
- "operationId": "actions/get-environment-secret",
53641
- "externalDocs": {
53642
- "description": "API method documentation",
53643
- "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-secret"
53644
- },
53645
- "parameters": [
53646
- {
53647
- "$ref": "#/components/parameters/repository-id"
53648
- },
53649
- {
53650
- "$ref": "#/components/parameters/environment-name"
53651
- },
53652
- {
53653
- "$ref": "#/components/parameters/secret-name"
53654
- }
53655
- ],
53656
- "responses": {
53657
- "200": {
53658
- "description": "Response",
53659
- "content": {
53660
- "application/json": {
53661
- "schema": {
53662
- "$ref": "#/components/schemas/actions-secret"
53663
- },
53664
- "examples": {
53665
- "default": {
53666
- "$ref": "#/components/examples/actions-secret"
53667
- }
53668
- }
53669
- }
53670
- }
53671
- }
53672
- },
53673
- "x-github": {
53674
- "githubCloudOnly": false,
53675
- "enabledForGitHubApps": true,
53676
- "category": "actions",
53677
- "subcategory": "secrets"
53678
- },
53679
- "x-octokit": {}
53680
- },
53681
- "put": {
53682
- "summary": "Create or update an environment secret",
53683
- "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-server@3.11/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.",
53684
- "tags": [
53685
- "actions"
53686
- ],
53687
- "operationId": "actions/create-or-update-environment-secret",
53688
- "externalDocs": {
53689
- "description": "API method documentation",
53690
- "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-environment-secret"
53691
- },
53692
- "parameters": [
53693
- {
53694
- "$ref": "#/components/parameters/repository-id"
53695
- },
53696
- {
53697
- "$ref": "#/components/parameters/environment-name"
53698
- },
53699
- {
53700
- "$ref": "#/components/parameters/secret-name"
53701
- }
53702
- ],
53703
- "requestBody": {
53704
- "required": true,
53705
- "content": {
53706
- "application/json": {
53707
- "schema": {
53708
- "type": "object",
53709
- "properties": {
53710
- "encrypted_value": {
53711
- "type": "string",
53712
- "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-server@3.11/rest/actions/secrets#get-an-environment-public-key) endpoint.",
53713
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
53714
- },
53715
- "key_id": {
53716
- "type": "string",
53717
- "description": "ID of the key you used to encrypt the secret."
53718
- }
53719
- },
53720
- "required": [
53721
- "encrypted_value",
53722
- "key_id"
53723
- ]
53724
- },
53725
- "examples": {
53726
- "default": {
53727
- "value": {
53728
- "encrypted_value": "c2VjcmV0",
53729
- "key_id": "012345678912345678"
53730
- }
53731
- }
53732
- }
53733
- }
53734
- }
53735
- },
53736
- "responses": {
53737
- "201": {
53738
- "description": "Response when creating a secret",
53739
- "content": {
53740
- "application/json": {
53741
- "schema": {
53742
- "$ref": "#/components/schemas/empty-object"
53743
- },
53744
- "examples": {
53745
- "default": {
53746
- "value": null
53747
- }
53748
- }
53749
- }
53750
- }
53751
- },
53752
- "204": {
53753
- "description": "Response when updating a secret"
53754
- }
53755
- },
53756
- "x-github": {
53757
- "githubCloudOnly": false,
53758
- "enabledForGitHubApps": true,
53759
- "category": "actions",
53760
- "subcategory": "secrets"
53761
- },
53762
- "x-octokit": {}
53763
- },
53764
- "delete": {
53765
- "summary": "Delete an environment secret",
53766
- "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.",
53767
- "tags": [
53768
- "actions"
53769
- ],
53770
- "operationId": "actions/delete-environment-secret",
53771
- "externalDocs": {
53772
- "description": "API method documentation",
53773
- "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#delete-an-environment-secret"
53774
- },
53775
- "parameters": [
53776
- {
53777
- "$ref": "#/components/parameters/repository-id"
53778
- },
53779
- {
53780
- "$ref": "#/components/parameters/environment-name"
53781
- },
53782
- {
53783
- "$ref": "#/components/parameters/secret-name"
53784
- }
53785
- ],
53786
- "responses": {
53787
- "204": {
53788
- "description": "Default response"
53789
- }
53790
- },
53791
- "x-github": {
53792
- "githubCloudOnly": false,
53793
- "enabledForGitHubApps": true,
53794
- "category": "actions",
53795
- "subcategory": "secrets"
53796
- },
53797
- "x-octokit": {}
53798
- }
53799
- },
53800
- "/repositories/{repository_id}/environments/{environment_name}/variables": {
53801
- "get": {
53802
- "summary": "List environment variables",
53803
- "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.",
53804
- "tags": [
53805
- "actions"
53806
- ],
53807
- "operationId": "actions/list-environment-variables",
53808
- "externalDocs": {
53809
- "description": "API method documentation",
53810
- "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#list-environment-variables"
53811
- },
53812
- "parameters": [
53813
- {
53814
- "$ref": "#/components/parameters/repository-id"
53815
- },
53816
- {
53817
- "$ref": "#/components/parameters/environment-name"
53818
- },
53819
- {
53820
- "$ref": "#/components/parameters/variables-per-page"
53821
- },
53822
- {
53823
- "$ref": "#/components/parameters/page"
53824
- }
53825
- ],
53826
- "responses": {
53827
- "200": {
53828
- "description": "Response",
53829
- "content": {
53830
- "application/json": {
53831
- "schema": {
53832
- "type": "object",
53833
- "required": [
53834
- "total_count",
53835
- "variables"
53836
- ],
53837
- "properties": {
53838
- "total_count": {
53839
- "type": "integer"
53840
- },
53841
- "variables": {
53842
- "type": "array",
53843
- "items": {
53844
- "$ref": "#/components/schemas/actions-variable"
53845
- }
53846
- }
53847
- }
53848
- },
53849
- "examples": {
53850
- "default": {
53851
- "$ref": "#/components/examples/actions-variables-paginated"
53852
- }
53853
- }
53854
- }
53855
- },
53856
- "headers": {
53857
- "Link": {
53858
- "$ref": "#/components/headers/link"
53859
- }
53860
- }
53861
- }
53862
- },
53863
- "x-github": {
53864
- "githubCloudOnly": false,
53865
- "enabledForGitHubApps": true,
53866
- "category": "actions",
53867
- "subcategory": "variables"
53868
- },
53869
- "x-octokit": {}
53870
- },
53871
- "post": {
53872
- "summary": "Create an environment variable",
53873
- "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.",
53874
- "tags": [
53875
- "actions"
53876
- ],
53877
- "operationId": "actions/create-environment-variable",
53878
- "externalDocs": {
53879
- "description": "API method documentation",
53880
- "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#create-an-environment-variable"
53881
- },
53882
- "parameters": [
53883
- {
53884
- "$ref": "#/components/parameters/repository-id"
53885
- },
53886
- {
53887
- "$ref": "#/components/parameters/environment-name"
53888
- }
53889
- ],
53890
- "requestBody": {
53891
- "required": true,
53892
- "content": {
53893
- "application/json": {
53894
- "schema": {
53895
- "type": "object",
53896
- "properties": {
53897
- "name": {
53898
- "type": "string",
53899
- "description": "The name of the variable."
53900
- },
53901
- "value": {
53902
- "type": "string",
53903
- "description": "The value of the variable."
53904
- }
53905
- },
53906
- "required": [
53907
- "name",
53908
- "value"
53909
- ]
53910
- },
53911
- "examples": {
53912
- "default": {
53913
- "value": {
53914
- "name": "USERNAME",
53915
- "value": "octocat"
53916
- }
53917
- }
53918
- }
53919
- }
53920
- }
53921
- },
53922
- "responses": {
53923
- "201": {
53924
- "description": "Response",
53925
- "content": {
53926
- "application/json": {
53927
- "schema": {
53928
- "$ref": "#/components/schemas/empty-object"
53929
- },
53930
- "examples": {
53931
- "default": {
53932
- "value": null
53933
- }
53934
- }
53935
- }
53936
- }
53937
- }
53938
- },
53939
- "x-github": {
53940
- "githubCloudOnly": false,
53941
- "enabledForGitHubApps": true,
53942
- "category": "actions",
53943
- "subcategory": "variables"
53944
- },
53945
- "x-octokit": {}
53946
- }
53947
- },
53948
- "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
53949
- "get": {
53950
- "summary": "Get an environment variable",
53951
- "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.",
53952
- "tags": [
53953
- "actions"
53954
- ],
53955
- "operationId": "actions/get-environment-variable",
53956
- "externalDocs": {
53957
- "description": "API method documentation",
53958
- "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#get-an-environment-variable"
53959
- },
53960
- "parameters": [
53961
- {
53962
- "$ref": "#/components/parameters/repository-id"
53963
- },
53964
- {
53965
- "$ref": "#/components/parameters/environment-name"
53966
- },
53967
- {
53968
- "$ref": "#/components/parameters/variable-name"
53969
- }
53970
- ],
53971
- "responses": {
53972
- "200": {
53973
- "description": "Response",
53974
- "content": {
53975
- "application/json": {
53976
- "schema": {
53977
- "$ref": "#/components/schemas/actions-variable"
53978
- },
53979
- "examples": {
53980
- "default": {
53981
- "$ref": "#/components/examples/actions-variable"
53982
- }
53983
- }
53984
- }
53985
- }
53986
- }
53987
- },
53988
- "x-github": {
53989
- "githubCloudOnly": false,
53990
- "enabledForGitHubApps": true,
53991
- "category": "actions",
53992
- "subcategory": "variables"
53993
- },
53994
- "x-octokit": {}
53995
- },
53996
- "patch": {
53997
- "summary": "Update an environment variable",
53998
- "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.",
53999
- "tags": [
54000
- "actions"
54001
- ],
54002
- "operationId": "actions/update-environment-variable",
54003
- "externalDocs": {
54004
- "description": "API method documentation",
54005
- "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#update-an-environment-variable"
54006
- },
54007
- "parameters": [
54008
- {
54009
- "$ref": "#/components/parameters/repository-id"
54010
- },
54011
- {
54012
- "$ref": "#/components/parameters/variable-name"
54013
- },
54014
- {
54015
- "$ref": "#/components/parameters/environment-name"
54016
- }
54017
- ],
54018
- "requestBody": {
54019
- "required": true,
54020
- "content": {
54021
- "application/json": {
54022
- "schema": {
54023
- "type": "object",
54024
- "properties": {
54025
- "name": {
54026
- "type": "string",
54027
- "description": "The name of the variable."
54028
- },
54029
- "value": {
54030
- "type": "string",
54031
- "description": "The value of the variable."
54032
- }
54033
- }
54034
- },
54035
- "examples": {
54036
- "default": {
54037
- "value": {
54038
- "name": "USERNAME",
54039
- "value": "octocat"
54040
- }
54041
- }
54042
- }
54043
- }
54044
- }
54045
- },
54046
- "responses": {
54047
- "204": {
54048
- "description": "Response"
54049
- }
54050
- },
54051
- "x-github": {
54052
- "githubCloudOnly": false,
54053
- "enabledForGitHubApps": true,
54054
- "category": "actions",
54055
- "subcategory": "variables"
54056
- },
54057
- "x-octokit": {}
54058
- },
54059
- "delete": {
54060
- "summary": "Delete an environment variable",
54061
- "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.",
54062
- "tags": [
54063
- "actions"
54064
- ],
54065
- "operationId": "actions/delete-environment-variable",
54066
- "externalDocs": {
54067
- "description": "API method documentation",
54068
- "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#delete-an-environment-variable"
54069
- },
54070
- "parameters": [
54071
- {
54072
- "$ref": "#/components/parameters/repository-id"
54073
- },
54074
- {
54075
- "$ref": "#/components/parameters/variable-name"
54076
- },
54077
- {
54078
- "$ref": "#/components/parameters/environment-name"
54079
- }
54080
- ],
54081
- "responses": {
54082
- "204": {
54083
- "description": "Response"
54084
- }
54085
- },
54086
- "x-github": {
54087
- "githubCloudOnly": false,
54088
- "enabledForGitHubApps": true,
54089
- "category": "actions",
54090
- "subcategory": "variables"
54091
- },
54092
- "x-octokit": {}
54093
- }
54094
- },
54095
- "/scim/v2/Groups": {
54156
+ "/scim/v2/enterprises/{enterprise}/Groups": {
54096
54157
  "get": {
54097
54158
  "summary": "List provisioned SCIM groups for an enterprise",
54098
54159
  "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently 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.",
@@ -54131,6 +54192,9 @@
54131
54192
  },
54132
54193
  {
54133
54194
  "$ref": "#/components/parameters/count"
54195
+ },
54196
+ {
54197
+ "$ref": "#/components/parameters/enterprise"
54134
54198
  }
54135
54199
  ],
54136
54200
  "responses": {
@@ -54184,6 +54248,11 @@
54184
54248
  "description": "API method documentation",
54185
54249
  "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#provision-a-scim-enterprise-group"
54186
54250
  },
54251
+ "parameters": [
54252
+ {
54253
+ "$ref": "#/components/parameters/enterprise"
54254
+ }
54255
+ ],
54187
54256
  "requestBody": {
54188
54257
  "required": true,
54189
54258
  "content": {
@@ -54249,7 +54318,7 @@
54249
54318
  "x-octokit": {}
54250
54319
  }
54251
54320
  },
54252
- "/scim/v2/Groups/{scim_group_id}": {
54321
+ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": {
54253
54322
  "get": {
54254
54323
  "summary": "Get SCIM provisioning information for an enterprise group",
54255
54324
  "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group.",
@@ -54267,6 +54336,9 @@
54267
54336
  },
54268
54337
  {
54269
54338
  "$ref": "#/components/parameters/excluded-attributes"
54339
+ },
54340
+ {
54341
+ "$ref": "#/components/parameters/enterprise"
54270
54342
  }
54271
54343
  ],
54272
54344
  "responses": {
@@ -54326,6 +54398,9 @@
54326
54398
  "parameters": [
54327
54399
  {
54328
54400
  "$ref": "#/components/parameters/scim-group-id"
54401
+ },
54402
+ {
54403
+ "$ref": "#/components/parameters/enterprise"
54329
54404
  }
54330
54405
  ],
54331
54406
  "requestBody": {
@@ -54433,6 +54508,9 @@
54433
54508
  "parameters": [
54434
54509
  {
54435
54510
  "$ref": "#/components/parameters/scim-group-id"
54511
+ },
54512
+ {
54513
+ "$ref": "#/components/parameters/enterprise"
54436
54514
  }
54437
54515
  ],
54438
54516
  "requestBody": {
@@ -54550,6 +54628,9 @@
54550
54628
  "parameters": [
54551
54629
  {
54552
54630
  "$ref": "#/components/parameters/scim-group-id"
54631
+ },
54632
+ {
54633
+ "$ref": "#/components/parameters/enterprise"
54553
54634
  }
54554
54635
  ],
54555
54636
  "responses": {
@@ -54584,7 +54665,7 @@
54584
54665
  "x-octokit": {}
54585
54666
  }
54586
54667
  },
54587
- "/scim/v2/Users": {
54668
+ "/scim/v2/enterprises/{enterprise}/Users": {
54588
54669
  "get": {
54589
54670
  "summary": "List SCIM provisioned identities for an enterprise",
54590
54671
  "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.",
@@ -54619,6 +54700,9 @@
54619
54700
  },
54620
54701
  {
54621
54702
  "$ref": "#/components/parameters/count"
54703
+ },
54704
+ {
54705
+ "$ref": "#/components/parameters/enterprise"
54622
54706
  }
54623
54707
  ],
54624
54708
  "responses": {
@@ -54672,6 +54756,11 @@
54672
54756
  "description": "API method documentation",
54673
54757
  "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#provision-a-scim-enterprise-user"
54674
54758
  },
54759
+ "parameters": [
54760
+ {
54761
+ "$ref": "#/components/parameters/enterprise"
54762
+ }
54763
+ ],
54675
54764
  "requestBody": {
54676
54765
  "required": true,
54677
54766
  "content": {
@@ -54737,7 +54826,7 @@
54737
54826
  "x-octokit": {}
54738
54827
  }
54739
54828
  },
54740
- "/scim/v2/Users/{scim_user_id}": {
54829
+ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": {
54741
54830
  "get": {
54742
54831
  "summary": "Get SCIM provisioning information for an enterprise user",
54743
54832
  "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user.",
@@ -54752,6 +54841,9 @@
54752
54841
  "parameters": [
54753
54842
  {
54754
54843
  "$ref": "#/components/parameters/scim-user-id"
54844
+ },
54845
+ {
54846
+ "$ref": "#/components/parameters/enterprise"
54755
54847
  }
54756
54848
  ],
54757
54849
  "responses": {
@@ -54811,6 +54903,9 @@
54811
54903
  "parameters": [
54812
54904
  {
54813
54905
  "$ref": "#/components/parameters/scim-user-id"
54906
+ },
54907
+ {
54908
+ "$ref": "#/components/parameters/enterprise"
54814
54909
  }
54815
54910
  ],
54816
54911
  "requestBody": {
@@ -54888,6 +54983,9 @@
54888
54983
  "parameters": [
54889
54984
  {
54890
54985
  "$ref": "#/components/parameters/scim-user-id"
54986
+ },
54987
+ {
54988
+ "$ref": "#/components/parameters/enterprise"
54891
54989
  }
54892
54990
  ],
54893
54991
  "requestBody": {
@@ -55023,6 +55121,9 @@
55023
55121
  "parameters": [
55024
55122
  {
55025
55123
  "$ref": "#/components/parameters/scim-user-id"
55124
+ },
55125
+ {
55126
+ "$ref": "#/components/parameters/enterprise"
55026
55127
  }
55027
55128
  ],
55028
55129
  "responses": {
@@ -63465,7 +63566,7 @@
63465
63566
  "/users/{username}/hovercard": {
63466
63567
  "get": {
63467
63568
  "summary": "Get contextual information for a user",
63468
- "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.",
63569
+ "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.",
63469
63570
  "tags": [
63470
63571
  "users"
63471
63572
  ],
@@ -84606,8 +84707,7 @@
84606
84707
  },
84607
84708
  "repository-dispatch-sample.collected": {
84608
84709
  "post": {
84609
- "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-server@3.11/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.",
84610
- "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.",
84710
+ "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-server@3.11/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.",
84611
84711
  "operationId": "repository-dispatch/sample.collected",
84612
84712
  "externalDocs": {
84613
84713
  "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#repository_dispatch"
@@ -89948,7 +90048,8 @@
89948
90048
  },
89949
90049
  "hub_url": {
89950
90050
  "type": "string",
89951
- "format": "uri-template"
90051
+ "format": "uri-template",
90052
+ "deprecated": true
89952
90053
  },
89953
90054
  "issue_search_url": {
89954
90055
  "type": "string",
@@ -90044,7 +90145,6 @@
90044
90145
  "followers_url",
90045
90146
  "following_url",
90046
90147
  "gists_url",
90047
- "hub_url",
90048
90148
  "issue_search_url",
90049
90149
  "issues_url",
90050
90150
  "keys_url",
@@ -102061,6 +102161,43 @@
102061
102161
  }
102062
102162
  }
102063
102163
  },
102164
+ "repository-rule-params-code-scanning-threshold": {
102165
+ "title": "CodeScanningThreshold",
102166
+ "description": "A tool and its thresholds.",
102167
+ "type": "object",
102168
+ "properties": {
102169
+ "alerts": {
102170
+ "type": "string",
102171
+ "description": "Code scanning alert threshold",
102172
+ "enum": [
102173
+ "none",
102174
+ "errors",
102175
+ "errors_and_warnings",
102176
+ "all"
102177
+ ]
102178
+ },
102179
+ "security_alerts": {
102180
+ "type": "string",
102181
+ "description": "Code scanning security alert threshold.",
102182
+ "enum": [
102183
+ "none",
102184
+ "critical",
102185
+ "high_or_higher",
102186
+ "medium_or_higher",
102187
+ "all"
102188
+ ]
102189
+ },
102190
+ "tool": {
102191
+ "type": "string",
102192
+ "description": "The name of a code scanning tool"
102193
+ }
102194
+ },
102195
+ "required": [
102196
+ "alerts",
102197
+ "security_alerts",
102198
+ "tool"
102199
+ ]
102200
+ },
102064
102201
  "repository-rule": {
102065
102202
  "title": "Repository Rule",
102066
102203
  "type": "object",
@@ -104166,7 +104303,9 @@
104166
104303
  "queued",
104167
104304
  "in_progress",
104168
104305
  "completed",
104169
- "waiting"
104306
+ "waiting",
104307
+ "requested",
104308
+ "pending"
104170
104309
  ]
104171
104310
  },
104172
104311
  "conclusion": {
@@ -106699,13 +106838,16 @@
106699
106838
  "nullable": true
106700
106839
  },
106701
106840
  "status": {
106702
- "description": "The phase of the lifecycle that the check is currently in.",
106841
+ "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.",
106703
106842
  "example": "queued",
106704
106843
  "type": "string",
106705
106844
  "enum": [
106706
106845
  "queued",
106707
106846
  "in_progress",
106708
- "completed"
106847
+ "completed",
106848
+ "waiting",
106849
+ "requested",
106850
+ "pending"
106709
106851
  ]
106710
106852
  },
106711
106853
  "conclusion": {
@@ -106983,11 +107125,15 @@
106983
107125
  },
106984
107126
  "status": {
106985
107127
  "type": "string",
107128
+ "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.",
106986
107129
  "example": "completed",
106987
107130
  "enum": [
106988
107131
  "queued",
106989
107132
  "in_progress",
106990
- "completed"
107133
+ "completed",
107134
+ "waiting",
107135
+ "requested",
107136
+ "pending"
106991
107137
  ],
106992
107138
  "nullable": true
106993
107139
  },
@@ -171241,6 +171387,7 @@
171241
171387
  "type": "object",
171242
171388
  "properties": {
171243
171389
  "permission": {
171390
+ "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.",
171244
171391
  "type": "object",
171245
171392
  "properties": {
171246
171393
  "to": {
@@ -171255,6 +171402,18 @@
171255
171402
  "required": [
171256
171403
  "to"
171257
171404
  ]
171405
+ },
171406
+ "role_name": {
171407
+ "description": "The role assigned to the collaborator.",
171408
+ "type": "object",
171409
+ "properties": {
171410
+ "to": {
171411
+ "type": "string"
171412
+ }
171413
+ },
171414
+ "required": [
171415
+ "to"
171416
+ ]
171258
171417
  }
171259
171418
  }
171260
171419
  },
@@ -249801,7 +249960,7 @@
249801
249960
  "type": "string"
249802
249961
  },
249803
249962
  "commits": {
249804
- "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-server@3.11/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.",
249963
+ "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-server@3.11/rest/commits) to fetch additional commits.",
249805
249964
  "type": "array",
249806
249965
  "items": {
249807
249966
  "title": "Commit",
@@ -255621,9 +255780,7 @@
255621
255780
  "properties": {
255622
255781
  "action": {
255623
255782
  "type": "string",
255624
- "enum": [
255625
- "sample.collected"
255626
- ]
255783
+ "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
255627
255784
  },
255628
255785
  "branch": {
255629
255786
  "type": "string"
@@ -255631,7 +255788,8 @@
255631
255788
  "client_payload": {
255632
255789
  "type": "object",
255633
255790
  "nullable": true,
255634
- "additionalProperties": true
255791
+ "additionalProperties": true,
255792
+ "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
255635
255793
  },
255636
255794
  "enterprise": {
255637
255795
  "$ref": "#/components/schemas/enterprise-webhooks"
@@ -293123,6 +293281,20 @@
293123
293281
  "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b"
293124
293282
  }
293125
293283
  },
293284
+ {
293285
+ "type": "wiki_commit",
293286
+ "details": {
293287
+ "path": "/example/Home.md",
293288
+ "start_line": 1,
293289
+ "end_line": 1,
293290
+ "start_column": 1,
293291
+ "end_column": 64,
293292
+ "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b",
293293
+ "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5",
293294
+ "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5",
293295
+ "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
293296
+ }
293297
+ },
293126
293298
  {
293127
293299
  "type": "issue_title",
293128
293300
  "details": {
@@ -299632,7 +299804,7 @@
299632
299804
  },
299633
299805
  "workflow-run-status": {
299634
299806
  "name": "status",
299635
- "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`.",
299807
+ "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`.",
299636
299808
  "in": "query",
299637
299809
  "required": false,
299638
299810
  "schema": {
@@ -299886,6 +300058,17 @@
299886
300058
  "type": "integer"
299887
300059
  }
299888
300060
  },
300061
+ "git-ref-only": {
300062
+ "name": "ref",
300063
+ "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.",
300064
+ "in": "path",
300065
+ "required": true,
300066
+ "example": "heads/feature-a",
300067
+ "schema": {
300068
+ "type": "string"
300069
+ },
300070
+ "x-multi-segment": true
300071
+ },
299889
300072
  "invitation-id": {
299890
300073
  "name": "invitation_id",
299891
300074
  "description": "The unique identifier of the invitation.",
@@ -300489,6 +300672,16 @@
300489
300672
  }
300490
300673
  }
300491
300674
  },
300675
+ "unacceptable": {
300676
+ "description": "Unacceptable",
300677
+ "content": {
300678
+ "application/json": {
300679
+ "schema": {
300680
+ "$ref": "#/components/schemas/basic-error"
300681
+ }
300682
+ }
300683
+ }
300684
+ },
300492
300685
  "scim_bad_request": {
300493
300686
  "description": "Bad request",
300494
300687
  "content": {