@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,
@@ -8773,7 +8758,7 @@
8773
8758
  "/feeds": {
8774
8759
  "get": {
8775
8760
  "summary": "Get feeds",
8776
- "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.12/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.12/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
8761
+ "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.12/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.12/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.12/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
8777
8762
  "tags": [
8778
8763
  "activity"
8779
8764
  ],
@@ -12307,7 +12292,7 @@
12307
12292
  "/organizations": {
12308
12293
  "get": {
12309
12294
  "summary": "List organizations",
12310
- "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.12/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
12295
+ "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.12/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
12311
12296
  "tags": [
12312
12297
  "orgs"
12313
12298
  ],
@@ -17310,7 +17295,7 @@
17310
17295
  "/orgs/{org}/hooks": {
17311
17296
  "get": {
17312
17297
  "summary": "List organization webhooks",
17313
- "description": "",
17298
+ "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.",
17314
17299
  "tags": [
17315
17300
  "orgs"
17316
17301
  ],
@@ -17368,7 +17353,7 @@
17368
17353
  },
17369
17354
  "post": {
17370
17355
  "summary": "Create an organization webhook",
17371
- "description": "Here's how you can create a hook that posts payloads in JSON format:",
17356
+ "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.",
17372
17357
  "tags": [
17373
17358
  "orgs"
17374
17359
  ],
@@ -17505,7 +17490,7 @@
17505
17490
  "/orgs/{org}/hooks/{hook_id}": {
17506
17491
  "get": {
17507
17492
  "summary": "Get an organization webhook",
17508
- "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).\"",
17493
+ "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.",
17509
17494
  "tags": [
17510
17495
  "orgs"
17511
17496
  ],
@@ -17552,7 +17537,7 @@
17552
17537
  },
17553
17538
  "patch": {
17554
17539
  "summary": "Update an organization webhook",
17555
- "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).\"",
17540
+ "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.",
17556
17541
  "tags": [
17557
17542
  "orgs"
17558
17543
  ],
@@ -17664,7 +17649,7 @@
17664
17649
  },
17665
17650
  "delete": {
17666
17651
  "summary": "Delete an organization webhook",
17667
- "description": "",
17652
+ "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.",
17668
17653
  "tags": [
17669
17654
  "orgs"
17670
17655
  ],
@@ -17701,7 +17686,7 @@
17701
17686
  "/orgs/{org}/hooks/{hook_id}/config": {
17702
17687
  "get": {
17703
17688
  "summary": "Get a webhook configuration for an organization",
17704
- "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.",
17689
+ "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.",
17705
17690
  "tags": [
17706
17691
  "orgs"
17707
17692
  ],
@@ -17745,7 +17730,7 @@
17745
17730
  },
17746
17731
  "patch": {
17747
17732
  "summary": "Update a webhook configuration for an organization",
17748
- "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.",
17733
+ "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.",
17749
17734
  "tags": [
17750
17735
  "orgs"
17751
17736
  ],
@@ -17826,7 +17811,7 @@
17826
17811
  "/orgs/{org}/hooks/{hook_id}/deliveries": {
17827
17812
  "get": {
17828
17813
  "summary": "List deliveries for an organization webhook",
17829
- "description": "Returns a list of webhook deliveries for a webhook configured in an organization.",
17814
+ "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.",
17830
17815
  "tags": [
17831
17816
  "orgs"
17832
17817
  ],
@@ -17895,7 +17880,7 @@
17895
17880
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
17896
17881
  "get": {
17897
17882
  "summary": "Get a webhook delivery for an organization webhook",
17898
- "description": "Returns a delivery for a webhook configured in an organization.",
17883
+ "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.",
17899
17884
  "tags": [
17900
17885
  "orgs"
17901
17886
  ],
@@ -17950,7 +17935,7 @@
17950
17935
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
17951
17936
  "post": {
17952
17937
  "summary": "Redeliver a delivery for an organization webhook",
17953
- "description": "Redeliver a delivery for a webhook configured in an organization.",
17938
+ "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.",
17954
17939
  "tags": [
17955
17940
  "orgs"
17956
17941
  ],
@@ -17993,7 +17978,7 @@
17993
17978
  "/orgs/{org}/hooks/{hook_id}/pings": {
17994
17979
  "post": {
17995
17980
  "summary": "Ping an organization webhook",
17996
- "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.12/webhooks/#ping-event) to be sent to the hook.",
17981
+ "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.12/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.",
17997
17982
  "tags": [
17998
17983
  "orgs"
17999
17984
  ],
@@ -28618,7 +28603,7 @@
28618
28603
  "/repos/{owner}/{repo}/actions/runs": {
28619
28604
  "get": {
28620
28605
  "summary": "List workflow runs for a repository",
28621
- "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.12/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.",
28606
+ "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.12/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`.",
28622
28607
  "tags": [
28623
28608
  "actions"
28624
28609
  ],
@@ -34440,11 +34425,14 @@
34440
34425
  },
34441
34426
  "status": {
34442
34427
  "type": "string",
34443
- "description": "The current status.",
34428
+ "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
34444
34429
  "enum": [
34445
34430
  "queued",
34446
34431
  "in_progress",
34447
- "completed"
34432
+ "completed",
34433
+ "waiting",
34434
+ "requested",
34435
+ "pending"
34448
34436
  ]
34449
34437
  },
34450
34438
  "conclusion": {
@@ -37099,6 +37087,9 @@
37099
37087
  }
37100
37088
  }
37101
37089
  },
37090
+ "409": {
37091
+ "$ref": "#/components/responses/conflict"
37092
+ },
37102
37093
  "422": {
37103
37094
  "$ref": "#/components/responses/validation_failed"
37104
37095
  }
@@ -37330,6 +37321,9 @@
37330
37321
  "$ref": "#/components/headers/link"
37331
37322
  }
37332
37323
  }
37324
+ },
37325
+ "409": {
37326
+ "$ref": "#/components/responses/conflict"
37333
37327
  }
37334
37328
  },
37335
37329
  "x-github": {
@@ -37389,6 +37383,9 @@
37389
37383
  "404": {
37390
37384
  "$ref": "#/components/responses/not_found"
37391
37385
  },
37386
+ "409": {
37387
+ "$ref": "#/components/responses/conflict"
37388
+ },
37392
37389
  "422": {
37393
37390
  "$ref": "#/components/responses/validation_failed"
37394
37391
  },
@@ -37726,7 +37723,7 @@
37726
37723
  "/repos/{owner}/{repo}/compare/{basehead}": {
37727
37724
  "get": {
37728
37725
  "summary": "Compare two commits",
37729
- "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.12/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.12/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.12/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. |",
37726
+ "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.12/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.12/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.12/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. |",
37730
37727
  "tags": [
37731
37728
  "repos"
37732
37729
  ],
@@ -39746,6 +39743,9 @@
39746
39743
  "204": {
39747
39744
  "description": "Response"
39748
39745
  },
39746
+ "404": {
39747
+ "$ref": "#/components/responses/not_found"
39748
+ },
39749
39749
  "422": {
39750
39750
  "$ref": "#/components/responses/validation_failed"
39751
39751
  }
@@ -40667,6 +40667,616 @@
40667
40667
  "x-octokit": {}
40668
40668
  }
40669
40669
  },
40670
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
40671
+ "get": {
40672
+ "summary": "List environment secrets",
40673
+ "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.",
40674
+ "tags": [
40675
+ "actions"
40676
+ ],
40677
+ "operationId": "actions/list-environment-secrets",
40678
+ "externalDocs": {
40679
+ "description": "API method documentation",
40680
+ "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#list-environment-secrets"
40681
+ },
40682
+ "parameters": [
40683
+ {
40684
+ "$ref": "#/components/parameters/owner"
40685
+ },
40686
+ {
40687
+ "$ref": "#/components/parameters/repo"
40688
+ },
40689
+ {
40690
+ "$ref": "#/components/parameters/environment-name"
40691
+ },
40692
+ {
40693
+ "$ref": "#/components/parameters/per-page"
40694
+ },
40695
+ {
40696
+ "$ref": "#/components/parameters/page"
40697
+ }
40698
+ ],
40699
+ "responses": {
40700
+ "200": {
40701
+ "description": "Response",
40702
+ "content": {
40703
+ "application/json": {
40704
+ "schema": {
40705
+ "type": "object",
40706
+ "required": [
40707
+ "total_count",
40708
+ "secrets"
40709
+ ],
40710
+ "properties": {
40711
+ "total_count": {
40712
+ "type": "integer"
40713
+ },
40714
+ "secrets": {
40715
+ "type": "array",
40716
+ "items": {
40717
+ "$ref": "#/components/schemas/actions-secret"
40718
+ }
40719
+ }
40720
+ }
40721
+ },
40722
+ "examples": {
40723
+ "default": {
40724
+ "$ref": "#/components/examples/actions-secret-paginated"
40725
+ }
40726
+ }
40727
+ }
40728
+ },
40729
+ "headers": {
40730
+ "Link": {
40731
+ "$ref": "#/components/headers/link"
40732
+ }
40733
+ }
40734
+ }
40735
+ },
40736
+ "x-github": {
40737
+ "githubCloudOnly": false,
40738
+ "enabledForGitHubApps": true,
40739
+ "category": "actions",
40740
+ "subcategory": "secrets"
40741
+ },
40742
+ "x-octokit": {}
40743
+ }
40744
+ },
40745
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
40746
+ "get": {
40747
+ "summary": "Get an environment public key",
40748
+ "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.",
40749
+ "tags": [
40750
+ "actions"
40751
+ ],
40752
+ "operationId": "actions/get-environment-public-key",
40753
+ "externalDocs": {
40754
+ "description": "API method documentation",
40755
+ "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#get-an-environment-public-key"
40756
+ },
40757
+ "parameters": [
40758
+ {
40759
+ "$ref": "#/components/parameters/owner"
40760
+ },
40761
+ {
40762
+ "$ref": "#/components/parameters/repo"
40763
+ },
40764
+ {
40765
+ "$ref": "#/components/parameters/environment-name"
40766
+ }
40767
+ ],
40768
+ "responses": {
40769
+ "200": {
40770
+ "description": "Response",
40771
+ "content": {
40772
+ "application/json": {
40773
+ "schema": {
40774
+ "$ref": "#/components/schemas/actions-public-key"
40775
+ },
40776
+ "examples": {
40777
+ "default": {
40778
+ "$ref": "#/components/examples/actions-public-key"
40779
+ }
40780
+ }
40781
+ }
40782
+ }
40783
+ }
40784
+ },
40785
+ "x-github": {
40786
+ "githubCloudOnly": false,
40787
+ "enabledForGitHubApps": true,
40788
+ "category": "actions",
40789
+ "subcategory": "secrets"
40790
+ },
40791
+ "x-octokit": {}
40792
+ }
40793
+ },
40794
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
40795
+ "get": {
40796
+ "summary": "Get an environment secret",
40797
+ "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.",
40798
+ "tags": [
40799
+ "actions"
40800
+ ],
40801
+ "operationId": "actions/get-environment-secret",
40802
+ "externalDocs": {
40803
+ "description": "API method documentation",
40804
+ "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#get-an-environment-secret"
40805
+ },
40806
+ "parameters": [
40807
+ {
40808
+ "$ref": "#/components/parameters/owner"
40809
+ },
40810
+ {
40811
+ "$ref": "#/components/parameters/repo"
40812
+ },
40813
+ {
40814
+ "$ref": "#/components/parameters/environment-name"
40815
+ },
40816
+ {
40817
+ "$ref": "#/components/parameters/secret-name"
40818
+ }
40819
+ ],
40820
+ "responses": {
40821
+ "200": {
40822
+ "description": "Response",
40823
+ "content": {
40824
+ "application/json": {
40825
+ "schema": {
40826
+ "$ref": "#/components/schemas/actions-secret"
40827
+ },
40828
+ "examples": {
40829
+ "default": {
40830
+ "$ref": "#/components/examples/actions-secret"
40831
+ }
40832
+ }
40833
+ }
40834
+ }
40835
+ }
40836
+ },
40837
+ "x-github": {
40838
+ "githubCloudOnly": false,
40839
+ "enabledForGitHubApps": true,
40840
+ "category": "actions",
40841
+ "subcategory": "secrets"
40842
+ },
40843
+ "x-octokit": {}
40844
+ },
40845
+ "put": {
40846
+ "summary": "Create or update an environment secret",
40847
+ "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.12/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.",
40848
+ "tags": [
40849
+ "actions"
40850
+ ],
40851
+ "operationId": "actions/create-or-update-environment-secret",
40852
+ "externalDocs": {
40853
+ "description": "API method documentation",
40854
+ "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#create-or-update-an-environment-secret"
40855
+ },
40856
+ "parameters": [
40857
+ {
40858
+ "$ref": "#/components/parameters/owner"
40859
+ },
40860
+ {
40861
+ "$ref": "#/components/parameters/repo"
40862
+ },
40863
+ {
40864
+ "$ref": "#/components/parameters/environment-name"
40865
+ },
40866
+ {
40867
+ "$ref": "#/components/parameters/secret-name"
40868
+ }
40869
+ ],
40870
+ "requestBody": {
40871
+ "required": true,
40872
+ "content": {
40873
+ "application/json": {
40874
+ "schema": {
40875
+ "type": "object",
40876
+ "properties": {
40877
+ "encrypted_value": {
40878
+ "type": "string",
40879
+ "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.12/rest/actions/secrets#get-an-environment-public-key) endpoint.",
40880
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
40881
+ },
40882
+ "key_id": {
40883
+ "type": "string",
40884
+ "description": "ID of the key you used to encrypt the secret."
40885
+ }
40886
+ },
40887
+ "required": [
40888
+ "encrypted_value",
40889
+ "key_id"
40890
+ ]
40891
+ },
40892
+ "examples": {
40893
+ "default": {
40894
+ "value": {
40895
+ "encrypted_value": "c2VjcmV0",
40896
+ "key_id": "012345678912345678"
40897
+ }
40898
+ }
40899
+ }
40900
+ }
40901
+ }
40902
+ },
40903
+ "responses": {
40904
+ "201": {
40905
+ "description": "Response when creating a secret",
40906
+ "content": {
40907
+ "application/json": {
40908
+ "schema": {
40909
+ "$ref": "#/components/schemas/empty-object"
40910
+ },
40911
+ "examples": {
40912
+ "default": {
40913
+ "value": null
40914
+ }
40915
+ }
40916
+ }
40917
+ }
40918
+ },
40919
+ "204": {
40920
+ "description": "Response when updating a secret"
40921
+ }
40922
+ },
40923
+ "x-github": {
40924
+ "githubCloudOnly": false,
40925
+ "enabledForGitHubApps": true,
40926
+ "category": "actions",
40927
+ "subcategory": "secrets"
40928
+ },
40929
+ "x-octokit": {}
40930
+ },
40931
+ "delete": {
40932
+ "summary": "Delete an environment secret",
40933
+ "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.",
40934
+ "tags": [
40935
+ "actions"
40936
+ ],
40937
+ "operationId": "actions/delete-environment-secret",
40938
+ "externalDocs": {
40939
+ "description": "API method documentation",
40940
+ "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#delete-an-environment-secret"
40941
+ },
40942
+ "parameters": [
40943
+ {
40944
+ "$ref": "#/components/parameters/owner"
40945
+ },
40946
+ {
40947
+ "$ref": "#/components/parameters/repo"
40948
+ },
40949
+ {
40950
+ "$ref": "#/components/parameters/environment-name"
40951
+ },
40952
+ {
40953
+ "$ref": "#/components/parameters/secret-name"
40954
+ }
40955
+ ],
40956
+ "responses": {
40957
+ "204": {
40958
+ "description": "Default response"
40959
+ }
40960
+ },
40961
+ "x-github": {
40962
+ "githubCloudOnly": false,
40963
+ "enabledForGitHubApps": true,
40964
+ "category": "actions",
40965
+ "subcategory": "secrets"
40966
+ },
40967
+ "x-octokit": {}
40968
+ }
40969
+ },
40970
+ "/repos/{owner}/{repo}/environments/{environment_name}/variables": {
40971
+ "get": {
40972
+ "summary": "List environment variables",
40973
+ "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.",
40974
+ "tags": [
40975
+ "actions"
40976
+ ],
40977
+ "operationId": "actions/list-environment-variables",
40978
+ "externalDocs": {
40979
+ "description": "API method documentation",
40980
+ "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#list-environment-variables"
40981
+ },
40982
+ "parameters": [
40983
+ {
40984
+ "$ref": "#/components/parameters/owner"
40985
+ },
40986
+ {
40987
+ "$ref": "#/components/parameters/repo"
40988
+ },
40989
+ {
40990
+ "$ref": "#/components/parameters/environment-name"
40991
+ },
40992
+ {
40993
+ "$ref": "#/components/parameters/variables-per-page"
40994
+ },
40995
+ {
40996
+ "$ref": "#/components/parameters/page"
40997
+ }
40998
+ ],
40999
+ "responses": {
41000
+ "200": {
41001
+ "description": "Response",
41002
+ "content": {
41003
+ "application/json": {
41004
+ "schema": {
41005
+ "type": "object",
41006
+ "required": [
41007
+ "total_count",
41008
+ "variables"
41009
+ ],
41010
+ "properties": {
41011
+ "total_count": {
41012
+ "type": "integer"
41013
+ },
41014
+ "variables": {
41015
+ "type": "array",
41016
+ "items": {
41017
+ "$ref": "#/components/schemas/actions-variable"
41018
+ }
41019
+ }
41020
+ }
41021
+ },
41022
+ "examples": {
41023
+ "default": {
41024
+ "$ref": "#/components/examples/actions-variables-paginated"
41025
+ }
41026
+ }
41027
+ }
41028
+ },
41029
+ "headers": {
41030
+ "Link": {
41031
+ "$ref": "#/components/headers/link"
41032
+ }
41033
+ }
41034
+ }
41035
+ },
41036
+ "x-github": {
41037
+ "githubCloudOnly": false,
41038
+ "enabledForGitHubApps": true,
41039
+ "category": "actions",
41040
+ "subcategory": "variables"
41041
+ },
41042
+ "x-octokit": {}
41043
+ },
41044
+ "post": {
41045
+ "summary": "Create an environment variable",
41046
+ "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.",
41047
+ "tags": [
41048
+ "actions"
41049
+ ],
41050
+ "operationId": "actions/create-environment-variable",
41051
+ "externalDocs": {
41052
+ "description": "API method documentation",
41053
+ "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#create-an-environment-variable"
41054
+ },
41055
+ "parameters": [
41056
+ {
41057
+ "$ref": "#/components/parameters/owner"
41058
+ },
41059
+ {
41060
+ "$ref": "#/components/parameters/repo"
41061
+ },
41062
+ {
41063
+ "$ref": "#/components/parameters/environment-name"
41064
+ }
41065
+ ],
41066
+ "requestBody": {
41067
+ "required": true,
41068
+ "content": {
41069
+ "application/json": {
41070
+ "schema": {
41071
+ "type": "object",
41072
+ "properties": {
41073
+ "name": {
41074
+ "type": "string",
41075
+ "description": "The name of the variable."
41076
+ },
41077
+ "value": {
41078
+ "type": "string",
41079
+ "description": "The value of the variable."
41080
+ }
41081
+ },
41082
+ "required": [
41083
+ "name",
41084
+ "value"
41085
+ ]
41086
+ },
41087
+ "examples": {
41088
+ "default": {
41089
+ "value": {
41090
+ "name": "USERNAME",
41091
+ "value": "octocat"
41092
+ }
41093
+ }
41094
+ }
41095
+ }
41096
+ }
41097
+ },
41098
+ "responses": {
41099
+ "201": {
41100
+ "description": "Response",
41101
+ "content": {
41102
+ "application/json": {
41103
+ "schema": {
41104
+ "$ref": "#/components/schemas/empty-object"
41105
+ },
41106
+ "examples": {
41107
+ "default": {
41108
+ "value": null
41109
+ }
41110
+ }
41111
+ }
41112
+ }
41113
+ }
41114
+ },
41115
+ "x-github": {
41116
+ "githubCloudOnly": false,
41117
+ "enabledForGitHubApps": true,
41118
+ "category": "actions",
41119
+ "subcategory": "variables"
41120
+ },
41121
+ "x-octokit": {}
41122
+ }
41123
+ },
41124
+ "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
41125
+ "get": {
41126
+ "summary": "Get an environment variable",
41127
+ "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.",
41128
+ "tags": [
41129
+ "actions"
41130
+ ],
41131
+ "operationId": "actions/get-environment-variable",
41132
+ "externalDocs": {
41133
+ "description": "API method documentation",
41134
+ "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#get-an-environment-variable"
41135
+ },
41136
+ "parameters": [
41137
+ {
41138
+ "$ref": "#/components/parameters/owner"
41139
+ },
41140
+ {
41141
+ "$ref": "#/components/parameters/repo"
41142
+ },
41143
+ {
41144
+ "$ref": "#/components/parameters/environment-name"
41145
+ },
41146
+ {
41147
+ "$ref": "#/components/parameters/variable-name"
41148
+ }
41149
+ ],
41150
+ "responses": {
41151
+ "200": {
41152
+ "description": "Response",
41153
+ "content": {
41154
+ "application/json": {
41155
+ "schema": {
41156
+ "$ref": "#/components/schemas/actions-variable"
41157
+ },
41158
+ "examples": {
41159
+ "default": {
41160
+ "$ref": "#/components/examples/actions-variable"
41161
+ }
41162
+ }
41163
+ }
41164
+ }
41165
+ }
41166
+ },
41167
+ "x-github": {
41168
+ "githubCloudOnly": false,
41169
+ "enabledForGitHubApps": true,
41170
+ "category": "actions",
41171
+ "subcategory": "variables"
41172
+ },
41173
+ "x-octokit": {}
41174
+ },
41175
+ "patch": {
41176
+ "summary": "Update an environment variable",
41177
+ "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.",
41178
+ "tags": [
41179
+ "actions"
41180
+ ],
41181
+ "operationId": "actions/update-environment-variable",
41182
+ "externalDocs": {
41183
+ "description": "API method documentation",
41184
+ "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#update-an-environment-variable"
41185
+ },
41186
+ "parameters": [
41187
+ {
41188
+ "$ref": "#/components/parameters/owner"
41189
+ },
41190
+ {
41191
+ "$ref": "#/components/parameters/repo"
41192
+ },
41193
+ {
41194
+ "$ref": "#/components/parameters/variable-name"
41195
+ },
41196
+ {
41197
+ "$ref": "#/components/parameters/environment-name"
41198
+ }
41199
+ ],
41200
+ "requestBody": {
41201
+ "required": true,
41202
+ "content": {
41203
+ "application/json": {
41204
+ "schema": {
41205
+ "type": "object",
41206
+ "properties": {
41207
+ "name": {
41208
+ "type": "string",
41209
+ "description": "The name of the variable."
41210
+ },
41211
+ "value": {
41212
+ "type": "string",
41213
+ "description": "The value of the variable."
41214
+ }
41215
+ }
41216
+ },
41217
+ "examples": {
41218
+ "default": {
41219
+ "value": {
41220
+ "name": "USERNAME",
41221
+ "value": "octocat"
41222
+ }
41223
+ }
41224
+ }
41225
+ }
41226
+ }
41227
+ },
41228
+ "responses": {
41229
+ "204": {
41230
+ "description": "Response"
41231
+ }
41232
+ },
41233
+ "x-github": {
41234
+ "githubCloudOnly": false,
41235
+ "enabledForGitHubApps": true,
41236
+ "category": "actions",
41237
+ "subcategory": "variables"
41238
+ },
41239
+ "x-octokit": {}
41240
+ },
41241
+ "delete": {
41242
+ "summary": "Delete an environment variable",
41243
+ "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.",
41244
+ "tags": [
41245
+ "actions"
41246
+ ],
41247
+ "operationId": "actions/delete-environment-variable",
41248
+ "externalDocs": {
41249
+ "description": "API method documentation",
41250
+ "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#delete-an-environment-variable"
41251
+ },
41252
+ "parameters": [
41253
+ {
41254
+ "$ref": "#/components/parameters/owner"
41255
+ },
41256
+ {
41257
+ "$ref": "#/components/parameters/repo"
41258
+ },
41259
+ {
41260
+ "$ref": "#/components/parameters/variable-name"
41261
+ },
41262
+ {
41263
+ "$ref": "#/components/parameters/environment-name"
41264
+ }
41265
+ ],
41266
+ "responses": {
41267
+ "204": {
41268
+ "description": "Response"
41269
+ }
41270
+ },
41271
+ "x-github": {
41272
+ "githubCloudOnly": false,
41273
+ "enabledForGitHubApps": true,
41274
+ "category": "actions",
41275
+ "subcategory": "variables"
41276
+ },
41277
+ "x-octokit": {}
41278
+ }
41279
+ },
40670
41280
  "/repos/{owner}/{repo}/events": {
40671
41281
  "get": {
40672
41282
  "summary": "List repository events",
@@ -41039,6 +41649,9 @@
41039
41649
  "404": {
41040
41650
  "$ref": "#/components/responses/not_found"
41041
41651
  },
41652
+ "409": {
41653
+ "$ref": "#/components/responses/conflict"
41654
+ },
41042
41655
  "422": {
41043
41656
  "$ref": "#/components/responses/validation_failed"
41044
41657
  }
@@ -41193,6 +41806,9 @@
41193
41806
  "404": {
41194
41807
  "$ref": "#/components/responses/not_found"
41195
41808
  },
41809
+ "409": {
41810
+ "$ref": "#/components/responses/conflict"
41811
+ },
41196
41812
  "422": {
41197
41813
  "$ref": "#/components/responses/validation_failed"
41198
41814
  }
@@ -41247,6 +41863,9 @@
41247
41863
  },
41248
41864
  "404": {
41249
41865
  "$ref": "#/components/responses/not_found"
41866
+ },
41867
+ "409": {
41868
+ "$ref": "#/components/responses/conflict"
41250
41869
  }
41251
41870
  },
41252
41871
  "x-github": {
@@ -41278,7 +41897,7 @@
41278
41897
  "$ref": "#/components/parameters/repo"
41279
41898
  },
41280
41899
  {
41281
- "$ref": "#/components/parameters/commit-ref"
41900
+ "$ref": "#/components/parameters/git-ref-only"
41282
41901
  }
41283
41902
  ],
41284
41903
  "responses": {
@@ -41304,6 +41923,9 @@
41304
41923
  "$ref": "#/components/headers/link"
41305
41924
  }
41306
41925
  }
41926
+ },
41927
+ "409": {
41928
+ "$ref": "#/components/responses/conflict"
41307
41929
  }
41308
41930
  },
41309
41931
  "x-github": {
@@ -41335,7 +41957,7 @@
41335
41957
  "$ref": "#/components/parameters/repo"
41336
41958
  },
41337
41959
  {
41338
- "$ref": "#/components/parameters/commit-ref"
41960
+ "$ref": "#/components/parameters/git-ref-only"
41339
41961
  }
41340
41962
  ],
41341
41963
  "responses": {
@@ -41356,6 +41978,9 @@
41356
41978
  },
41357
41979
  "404": {
41358
41980
  "$ref": "#/components/responses/not_found"
41981
+ },
41982
+ "409": {
41983
+ "$ref": "#/components/responses/conflict"
41359
41984
  }
41360
41985
  },
41361
41986
  "x-github": {
@@ -41443,6 +42068,9 @@
41443
42068
  }
41444
42069
  }
41445
42070
  },
42071
+ "409": {
42072
+ "$ref": "#/components/responses/conflict"
42073
+ },
41446
42074
  "422": {
41447
42075
  "$ref": "#/components/responses/validation_failed"
41448
42076
  }
@@ -41459,7 +42087,7 @@
41459
42087
  "/repos/{owner}/{repo}/git/refs/{ref}": {
41460
42088
  "patch": {
41461
42089
  "summary": "Update a reference",
41462
- "description": "",
42090
+ "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.",
41463
42091
  "tags": [
41464
42092
  "git"
41465
42093
  ],
@@ -41476,15 +42104,7 @@
41476
42104
  "$ref": "#/components/parameters/repo"
41477
42105
  },
41478
42106
  {
41479
- "name": "ref",
41480
- "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.",
41481
- "in": "path",
41482
- "required": true,
41483
- "example": "heads/featureA",
41484
- "schema": {
41485
- "type": "string"
41486
- },
41487
- "x-multi-segment": true
42107
+ "$ref": "#/components/parameters/git-ref-only"
41488
42108
  }
41489
42109
  ],
41490
42110
  "requestBody": {
@@ -41535,6 +42155,9 @@
41535
42155
  }
41536
42156
  }
41537
42157
  },
42158
+ "409": {
42159
+ "$ref": "#/components/responses/conflict"
42160
+ },
41538
42161
  "422": {
41539
42162
  "$ref": "#/components/responses/validation_failed"
41540
42163
  }
@@ -41549,7 +42172,7 @@
41549
42172
  },
41550
42173
  "delete": {
41551
42174
  "summary": "Delete a reference",
41552
- "description": "",
42175
+ "description": "Deletes the provided reference.",
41553
42176
  "tags": [
41554
42177
  "git"
41555
42178
  ],
@@ -41566,13 +42189,16 @@
41566
42189
  "$ref": "#/components/parameters/repo"
41567
42190
  },
41568
42191
  {
41569
- "$ref": "#/components/parameters/commit-ref"
42192
+ "$ref": "#/components/parameters/git-ref-only"
41570
42193
  }
41571
42194
  ],
41572
42195
  "responses": {
41573
42196
  "204": {
41574
42197
  "description": "Response"
41575
42198
  },
42199
+ "409": {
42200
+ "$ref": "#/components/responses/conflict"
42201
+ },
41576
42202
  "422": {
41577
42203
  "$ref": "#/components/responses/validation_failed"
41578
42204
  }
@@ -41707,6 +42333,9 @@
41707
42333
  }
41708
42334
  }
41709
42335
  },
42336
+ "409": {
42337
+ "$ref": "#/components/responses/conflict"
42338
+ },
41710
42339
  "422": {
41711
42340
  "$ref": "#/components/responses/validation_failed"
41712
42341
  }
@@ -41766,6 +42395,9 @@
41766
42395
  },
41767
42396
  "404": {
41768
42397
  "$ref": "#/components/responses/not_found"
42398
+ },
42399
+ "409": {
42400
+ "$ref": "#/components/responses/conflict"
41769
42401
  }
41770
42402
  },
41771
42403
  "x-github": {
@@ -41903,6 +42535,9 @@
41903
42535
  "404": {
41904
42536
  "$ref": "#/components/responses/not_found"
41905
42537
  },
42538
+ "409": {
42539
+ "$ref": "#/components/responses/conflict"
42540
+ },
41906
42541
  "422": {
41907
42542
  "$ref": "#/components/responses/validation_failed"
41908
42543
  }
@@ -41977,6 +42612,9 @@
41977
42612
  "404": {
41978
42613
  "$ref": "#/components/responses/not_found"
41979
42614
  },
42615
+ "409": {
42616
+ "$ref": "#/components/responses/conflict"
42617
+ },
41980
42618
  "422": {
41981
42619
  "$ref": "#/components/responses/validation_failed"
41982
42620
  }
@@ -48805,6 +49443,9 @@
48805
49443
  "404": {
48806
49444
  "$ref": "#/components/responses/not_found"
48807
49445
  },
49446
+ "406": {
49447
+ "$ref": "#/components/responses/unacceptable"
49448
+ },
48808
49449
  "500": {
48809
49450
  "$ref": "#/components/responses/internal_error"
48810
49451
  },
@@ -54490,587 +55131,7 @@
54490
55131
  "x-octokit": {}
54491
55132
  }
54492
55133
  },
54493
- "/repositories/{repository_id}/environments/{environment_name}/secrets": {
54494
- "get": {
54495
- "summary": "List environment secrets",
54496
- "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.",
54497
- "tags": [
54498
- "actions"
54499
- ],
54500
- "operationId": "actions/list-environment-secrets",
54501
- "externalDocs": {
54502
- "description": "API method documentation",
54503
- "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#list-environment-secrets"
54504
- },
54505
- "parameters": [
54506
- {
54507
- "$ref": "#/components/parameters/repository-id"
54508
- },
54509
- {
54510
- "$ref": "#/components/parameters/environment-name"
54511
- },
54512
- {
54513
- "$ref": "#/components/parameters/per-page"
54514
- },
54515
- {
54516
- "$ref": "#/components/parameters/page"
54517
- }
54518
- ],
54519
- "responses": {
54520
- "200": {
54521
- "description": "Response",
54522
- "content": {
54523
- "application/json": {
54524
- "schema": {
54525
- "type": "object",
54526
- "required": [
54527
- "total_count",
54528
- "secrets"
54529
- ],
54530
- "properties": {
54531
- "total_count": {
54532
- "type": "integer"
54533
- },
54534
- "secrets": {
54535
- "type": "array",
54536
- "items": {
54537
- "$ref": "#/components/schemas/actions-secret"
54538
- }
54539
- }
54540
- }
54541
- },
54542
- "examples": {
54543
- "default": {
54544
- "$ref": "#/components/examples/actions-secret-paginated"
54545
- }
54546
- }
54547
- }
54548
- },
54549
- "headers": {
54550
- "Link": {
54551
- "$ref": "#/components/headers/link"
54552
- }
54553
- }
54554
- }
54555
- },
54556
- "x-github": {
54557
- "githubCloudOnly": false,
54558
- "enabledForGitHubApps": true,
54559
- "category": "actions",
54560
- "subcategory": "secrets"
54561
- },
54562
- "x-octokit": {}
54563
- }
54564
- },
54565
- "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
54566
- "get": {
54567
- "summary": "Get an environment public key",
54568
- "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.",
54569
- "tags": [
54570
- "actions"
54571
- ],
54572
- "operationId": "actions/get-environment-public-key",
54573
- "externalDocs": {
54574
- "description": "API method documentation",
54575
- "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#get-an-environment-public-key"
54576
- },
54577
- "parameters": [
54578
- {
54579
- "$ref": "#/components/parameters/repository-id"
54580
- },
54581
- {
54582
- "$ref": "#/components/parameters/environment-name"
54583
- }
54584
- ],
54585
- "responses": {
54586
- "200": {
54587
- "description": "Response",
54588
- "content": {
54589
- "application/json": {
54590
- "schema": {
54591
- "$ref": "#/components/schemas/actions-public-key"
54592
- },
54593
- "examples": {
54594
- "default": {
54595
- "$ref": "#/components/examples/actions-public-key"
54596
- }
54597
- }
54598
- }
54599
- }
54600
- }
54601
- },
54602
- "x-github": {
54603
- "githubCloudOnly": false,
54604
- "enabledForGitHubApps": true,
54605
- "category": "actions",
54606
- "subcategory": "secrets"
54607
- },
54608
- "x-octokit": {}
54609
- }
54610
- },
54611
- "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
54612
- "get": {
54613
- "summary": "Get an environment secret",
54614
- "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.",
54615
- "tags": [
54616
- "actions"
54617
- ],
54618
- "operationId": "actions/get-environment-secret",
54619
- "externalDocs": {
54620
- "description": "API method documentation",
54621
- "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#get-an-environment-secret"
54622
- },
54623
- "parameters": [
54624
- {
54625
- "$ref": "#/components/parameters/repository-id"
54626
- },
54627
- {
54628
- "$ref": "#/components/parameters/environment-name"
54629
- },
54630
- {
54631
- "$ref": "#/components/parameters/secret-name"
54632
- }
54633
- ],
54634
- "responses": {
54635
- "200": {
54636
- "description": "Response",
54637
- "content": {
54638
- "application/json": {
54639
- "schema": {
54640
- "$ref": "#/components/schemas/actions-secret"
54641
- },
54642
- "examples": {
54643
- "default": {
54644
- "$ref": "#/components/examples/actions-secret"
54645
- }
54646
- }
54647
- }
54648
- }
54649
- }
54650
- },
54651
- "x-github": {
54652
- "githubCloudOnly": false,
54653
- "enabledForGitHubApps": true,
54654
- "category": "actions",
54655
- "subcategory": "secrets"
54656
- },
54657
- "x-octokit": {}
54658
- },
54659
- "put": {
54660
- "summary": "Create or update an environment secret",
54661
- "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.12/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.",
54662
- "tags": [
54663
- "actions"
54664
- ],
54665
- "operationId": "actions/create-or-update-environment-secret",
54666
- "externalDocs": {
54667
- "description": "API method documentation",
54668
- "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#create-or-update-an-environment-secret"
54669
- },
54670
- "parameters": [
54671
- {
54672
- "$ref": "#/components/parameters/repository-id"
54673
- },
54674
- {
54675
- "$ref": "#/components/parameters/environment-name"
54676
- },
54677
- {
54678
- "$ref": "#/components/parameters/secret-name"
54679
- }
54680
- ],
54681
- "requestBody": {
54682
- "required": true,
54683
- "content": {
54684
- "application/json": {
54685
- "schema": {
54686
- "type": "object",
54687
- "properties": {
54688
- "encrypted_value": {
54689
- "type": "string",
54690
- "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.12/rest/actions/secrets#get-an-environment-public-key) endpoint.",
54691
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
54692
- },
54693
- "key_id": {
54694
- "type": "string",
54695
- "description": "ID of the key you used to encrypt the secret."
54696
- }
54697
- },
54698
- "required": [
54699
- "encrypted_value",
54700
- "key_id"
54701
- ]
54702
- },
54703
- "examples": {
54704
- "default": {
54705
- "value": {
54706
- "encrypted_value": "c2VjcmV0",
54707
- "key_id": "012345678912345678"
54708
- }
54709
- }
54710
- }
54711
- }
54712
- }
54713
- },
54714
- "responses": {
54715
- "201": {
54716
- "description": "Response when creating a secret",
54717
- "content": {
54718
- "application/json": {
54719
- "schema": {
54720
- "$ref": "#/components/schemas/empty-object"
54721
- },
54722
- "examples": {
54723
- "default": {
54724
- "value": null
54725
- }
54726
- }
54727
- }
54728
- }
54729
- },
54730
- "204": {
54731
- "description": "Response when updating a secret"
54732
- }
54733
- },
54734
- "x-github": {
54735
- "githubCloudOnly": false,
54736
- "enabledForGitHubApps": true,
54737
- "category": "actions",
54738
- "subcategory": "secrets"
54739
- },
54740
- "x-octokit": {}
54741
- },
54742
- "delete": {
54743
- "summary": "Delete an environment secret",
54744
- "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.",
54745
- "tags": [
54746
- "actions"
54747
- ],
54748
- "operationId": "actions/delete-environment-secret",
54749
- "externalDocs": {
54750
- "description": "API method documentation",
54751
- "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#delete-an-environment-secret"
54752
- },
54753
- "parameters": [
54754
- {
54755
- "$ref": "#/components/parameters/repository-id"
54756
- },
54757
- {
54758
- "$ref": "#/components/parameters/environment-name"
54759
- },
54760
- {
54761
- "$ref": "#/components/parameters/secret-name"
54762
- }
54763
- ],
54764
- "responses": {
54765
- "204": {
54766
- "description": "Default response"
54767
- }
54768
- },
54769
- "x-github": {
54770
- "githubCloudOnly": false,
54771
- "enabledForGitHubApps": true,
54772
- "category": "actions",
54773
- "subcategory": "secrets"
54774
- },
54775
- "x-octokit": {}
54776
- }
54777
- },
54778
- "/repositories/{repository_id}/environments/{environment_name}/variables": {
54779
- "get": {
54780
- "summary": "List environment variables",
54781
- "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.",
54782
- "tags": [
54783
- "actions"
54784
- ],
54785
- "operationId": "actions/list-environment-variables",
54786
- "externalDocs": {
54787
- "description": "API method documentation",
54788
- "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#list-environment-variables"
54789
- },
54790
- "parameters": [
54791
- {
54792
- "$ref": "#/components/parameters/repository-id"
54793
- },
54794
- {
54795
- "$ref": "#/components/parameters/environment-name"
54796
- },
54797
- {
54798
- "$ref": "#/components/parameters/variables-per-page"
54799
- },
54800
- {
54801
- "$ref": "#/components/parameters/page"
54802
- }
54803
- ],
54804
- "responses": {
54805
- "200": {
54806
- "description": "Response",
54807
- "content": {
54808
- "application/json": {
54809
- "schema": {
54810
- "type": "object",
54811
- "required": [
54812
- "total_count",
54813
- "variables"
54814
- ],
54815
- "properties": {
54816
- "total_count": {
54817
- "type": "integer"
54818
- },
54819
- "variables": {
54820
- "type": "array",
54821
- "items": {
54822
- "$ref": "#/components/schemas/actions-variable"
54823
- }
54824
- }
54825
- }
54826
- },
54827
- "examples": {
54828
- "default": {
54829
- "$ref": "#/components/examples/actions-variables-paginated"
54830
- }
54831
- }
54832
- }
54833
- },
54834
- "headers": {
54835
- "Link": {
54836
- "$ref": "#/components/headers/link"
54837
- }
54838
- }
54839
- }
54840
- },
54841
- "x-github": {
54842
- "githubCloudOnly": false,
54843
- "enabledForGitHubApps": true,
54844
- "category": "actions",
54845
- "subcategory": "variables"
54846
- },
54847
- "x-octokit": {}
54848
- },
54849
- "post": {
54850
- "summary": "Create an environment variable",
54851
- "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.",
54852
- "tags": [
54853
- "actions"
54854
- ],
54855
- "operationId": "actions/create-environment-variable",
54856
- "externalDocs": {
54857
- "description": "API method documentation",
54858
- "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#create-an-environment-variable"
54859
- },
54860
- "parameters": [
54861
- {
54862
- "$ref": "#/components/parameters/repository-id"
54863
- },
54864
- {
54865
- "$ref": "#/components/parameters/environment-name"
54866
- }
54867
- ],
54868
- "requestBody": {
54869
- "required": true,
54870
- "content": {
54871
- "application/json": {
54872
- "schema": {
54873
- "type": "object",
54874
- "properties": {
54875
- "name": {
54876
- "type": "string",
54877
- "description": "The name of the variable."
54878
- },
54879
- "value": {
54880
- "type": "string",
54881
- "description": "The value of the variable."
54882
- }
54883
- },
54884
- "required": [
54885
- "name",
54886
- "value"
54887
- ]
54888
- },
54889
- "examples": {
54890
- "default": {
54891
- "value": {
54892
- "name": "USERNAME",
54893
- "value": "octocat"
54894
- }
54895
- }
54896
- }
54897
- }
54898
- }
54899
- },
54900
- "responses": {
54901
- "201": {
54902
- "description": "Response",
54903
- "content": {
54904
- "application/json": {
54905
- "schema": {
54906
- "$ref": "#/components/schemas/empty-object"
54907
- },
54908
- "examples": {
54909
- "default": {
54910
- "value": null
54911
- }
54912
- }
54913
- }
54914
- }
54915
- }
54916
- },
54917
- "x-github": {
54918
- "githubCloudOnly": false,
54919
- "enabledForGitHubApps": true,
54920
- "category": "actions",
54921
- "subcategory": "variables"
54922
- },
54923
- "x-octokit": {}
54924
- }
54925
- },
54926
- "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
54927
- "get": {
54928
- "summary": "Get an environment variable",
54929
- "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.",
54930
- "tags": [
54931
- "actions"
54932
- ],
54933
- "operationId": "actions/get-environment-variable",
54934
- "externalDocs": {
54935
- "description": "API method documentation",
54936
- "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#get-an-environment-variable"
54937
- },
54938
- "parameters": [
54939
- {
54940
- "$ref": "#/components/parameters/repository-id"
54941
- },
54942
- {
54943
- "$ref": "#/components/parameters/environment-name"
54944
- },
54945
- {
54946
- "$ref": "#/components/parameters/variable-name"
54947
- }
54948
- ],
54949
- "responses": {
54950
- "200": {
54951
- "description": "Response",
54952
- "content": {
54953
- "application/json": {
54954
- "schema": {
54955
- "$ref": "#/components/schemas/actions-variable"
54956
- },
54957
- "examples": {
54958
- "default": {
54959
- "$ref": "#/components/examples/actions-variable"
54960
- }
54961
- }
54962
- }
54963
- }
54964
- }
54965
- },
54966
- "x-github": {
54967
- "githubCloudOnly": false,
54968
- "enabledForGitHubApps": true,
54969
- "category": "actions",
54970
- "subcategory": "variables"
54971
- },
54972
- "x-octokit": {}
54973
- },
54974
- "patch": {
54975
- "summary": "Update an environment variable",
54976
- "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.",
54977
- "tags": [
54978
- "actions"
54979
- ],
54980
- "operationId": "actions/update-environment-variable",
54981
- "externalDocs": {
54982
- "description": "API method documentation",
54983
- "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#update-an-environment-variable"
54984
- },
54985
- "parameters": [
54986
- {
54987
- "$ref": "#/components/parameters/repository-id"
54988
- },
54989
- {
54990
- "$ref": "#/components/parameters/variable-name"
54991
- },
54992
- {
54993
- "$ref": "#/components/parameters/environment-name"
54994
- }
54995
- ],
54996
- "requestBody": {
54997
- "required": true,
54998
- "content": {
54999
- "application/json": {
55000
- "schema": {
55001
- "type": "object",
55002
- "properties": {
55003
- "name": {
55004
- "type": "string",
55005
- "description": "The name of the variable."
55006
- },
55007
- "value": {
55008
- "type": "string",
55009
- "description": "The value of the variable."
55010
- }
55011
- }
55012
- },
55013
- "examples": {
55014
- "default": {
55015
- "value": {
55016
- "name": "USERNAME",
55017
- "value": "octocat"
55018
- }
55019
- }
55020
- }
55021
- }
55022
- }
55023
- },
55024
- "responses": {
55025
- "204": {
55026
- "description": "Response"
55027
- }
55028
- },
55029
- "x-github": {
55030
- "githubCloudOnly": false,
55031
- "enabledForGitHubApps": true,
55032
- "category": "actions",
55033
- "subcategory": "variables"
55034
- },
55035
- "x-octokit": {}
55036
- },
55037
- "delete": {
55038
- "summary": "Delete an environment variable",
55039
- "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.",
55040
- "tags": [
55041
- "actions"
55042
- ],
55043
- "operationId": "actions/delete-environment-variable",
55044
- "externalDocs": {
55045
- "description": "API method documentation",
55046
- "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#delete-an-environment-variable"
55047
- },
55048
- "parameters": [
55049
- {
55050
- "$ref": "#/components/parameters/repository-id"
55051
- },
55052
- {
55053
- "$ref": "#/components/parameters/variable-name"
55054
- },
55055
- {
55056
- "$ref": "#/components/parameters/environment-name"
55057
- }
55058
- ],
55059
- "responses": {
55060
- "204": {
55061
- "description": "Response"
55062
- }
55063
- },
55064
- "x-github": {
55065
- "githubCloudOnly": false,
55066
- "enabledForGitHubApps": true,
55067
- "category": "actions",
55068
- "subcategory": "variables"
55069
- },
55070
- "x-octokit": {}
55071
- }
55072
- },
55073
- "/scim/v2/Groups": {
55134
+ "/scim/v2/enterprises/{enterprise}/Groups": {
55074
55135
  "get": {
55075
55136
  "summary": "List provisioned SCIM groups for an enterprise",
55076
55137
  "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.",
@@ -55109,6 +55170,9 @@
55109
55170
  },
55110
55171
  {
55111
55172
  "$ref": "#/components/parameters/count"
55173
+ },
55174
+ {
55175
+ "$ref": "#/components/parameters/enterprise"
55112
55176
  }
55113
55177
  ],
55114
55178
  "responses": {
@@ -55162,6 +55226,11 @@
55162
55226
  "description": "API method documentation",
55163
55227
  "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/scim#provision-a-scim-enterprise-group"
55164
55228
  },
55229
+ "parameters": [
55230
+ {
55231
+ "$ref": "#/components/parameters/enterprise"
55232
+ }
55233
+ ],
55165
55234
  "requestBody": {
55166
55235
  "required": true,
55167
55236
  "content": {
@@ -55227,7 +55296,7 @@
55227
55296
  "x-octokit": {}
55228
55297
  }
55229
55298
  },
55230
- "/scim/v2/Groups/{scim_group_id}": {
55299
+ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": {
55231
55300
  "get": {
55232
55301
  "summary": "Get SCIM provisioning information for an enterprise group",
55233
55302
  "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.",
@@ -55245,6 +55314,9 @@
55245
55314
  },
55246
55315
  {
55247
55316
  "$ref": "#/components/parameters/excluded-attributes"
55317
+ },
55318
+ {
55319
+ "$ref": "#/components/parameters/enterprise"
55248
55320
  }
55249
55321
  ],
55250
55322
  "responses": {
@@ -55304,6 +55376,9 @@
55304
55376
  "parameters": [
55305
55377
  {
55306
55378
  "$ref": "#/components/parameters/scim-group-id"
55379
+ },
55380
+ {
55381
+ "$ref": "#/components/parameters/enterprise"
55307
55382
  }
55308
55383
  ],
55309
55384
  "requestBody": {
@@ -55411,6 +55486,9 @@
55411
55486
  "parameters": [
55412
55487
  {
55413
55488
  "$ref": "#/components/parameters/scim-group-id"
55489
+ },
55490
+ {
55491
+ "$ref": "#/components/parameters/enterprise"
55414
55492
  }
55415
55493
  ],
55416
55494
  "requestBody": {
@@ -55528,6 +55606,9 @@
55528
55606
  "parameters": [
55529
55607
  {
55530
55608
  "$ref": "#/components/parameters/scim-group-id"
55609
+ },
55610
+ {
55611
+ "$ref": "#/components/parameters/enterprise"
55531
55612
  }
55532
55613
  ],
55533
55614
  "responses": {
@@ -55562,7 +55643,7 @@
55562
55643
  "x-octokit": {}
55563
55644
  }
55564
55645
  },
55565
- "/scim/v2/Users": {
55646
+ "/scim/v2/enterprises/{enterprise}/Users": {
55566
55647
  "get": {
55567
55648
  "summary": "List SCIM provisioned identities for an enterprise",
55568
55649
  "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.",
@@ -55597,6 +55678,9 @@
55597
55678
  },
55598
55679
  {
55599
55680
  "$ref": "#/components/parameters/count"
55681
+ },
55682
+ {
55683
+ "$ref": "#/components/parameters/enterprise"
55600
55684
  }
55601
55685
  ],
55602
55686
  "responses": {
@@ -55650,6 +55734,11 @@
55650
55734
  "description": "API method documentation",
55651
55735
  "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/scim#provision-a-scim-enterprise-user"
55652
55736
  },
55737
+ "parameters": [
55738
+ {
55739
+ "$ref": "#/components/parameters/enterprise"
55740
+ }
55741
+ ],
55653
55742
  "requestBody": {
55654
55743
  "required": true,
55655
55744
  "content": {
@@ -55715,7 +55804,7 @@
55715
55804
  "x-octokit": {}
55716
55805
  }
55717
55806
  },
55718
- "/scim/v2/Users/{scim_user_id}": {
55807
+ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": {
55719
55808
  "get": {
55720
55809
  "summary": "Get SCIM provisioning information for an enterprise user",
55721
55810
  "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.",
@@ -55730,6 +55819,9 @@
55730
55819
  "parameters": [
55731
55820
  {
55732
55821
  "$ref": "#/components/parameters/scim-user-id"
55822
+ },
55823
+ {
55824
+ "$ref": "#/components/parameters/enterprise"
55733
55825
  }
55734
55826
  ],
55735
55827
  "responses": {
@@ -55789,6 +55881,9 @@
55789
55881
  "parameters": [
55790
55882
  {
55791
55883
  "$ref": "#/components/parameters/scim-user-id"
55884
+ },
55885
+ {
55886
+ "$ref": "#/components/parameters/enterprise"
55792
55887
  }
55793
55888
  ],
55794
55889
  "requestBody": {
@@ -55866,6 +55961,9 @@
55866
55961
  "parameters": [
55867
55962
  {
55868
55963
  "$ref": "#/components/parameters/scim-user-id"
55964
+ },
55965
+ {
55966
+ "$ref": "#/components/parameters/enterprise"
55869
55967
  }
55870
55968
  ],
55871
55969
  "requestBody": {
@@ -56001,6 +56099,9 @@
56001
56099
  "parameters": [
56002
56100
  {
56003
56101
  "$ref": "#/components/parameters/scim-user-id"
56102
+ },
56103
+ {
56104
+ "$ref": "#/components/parameters/enterprise"
56004
56105
  }
56005
56106
  ],
56006
56107
  "responses": {
@@ -64443,7 +64544,7 @@
64443
64544
  "/users/{username}/hovercard": {
64444
64545
  "get": {
64445
64546
  "summary": "Get contextual information for a user",
64446
- "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.",
64547
+ "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.",
64447
64548
  "tags": [
64448
64549
  "users"
64449
64550
  ],
@@ -85802,8 +85903,7 @@
85802
85903
  },
85803
85904
  "repository-dispatch-sample.collected": {
85804
85905
  "post": {
85805
- "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.12/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.",
85806
- "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.",
85906
+ "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.12/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.",
85807
85907
  "operationId": "repository-dispatch/sample.collected",
85808
85908
  "externalDocs": {
85809
85909
  "url": "https://docs.github.com/enterprise-server@3.12/webhooks/webhook-events-and-payloads#repository_dispatch"
@@ -91144,7 +91244,8 @@
91144
91244
  },
91145
91245
  "hub_url": {
91146
91246
  "type": "string",
91147
- "format": "uri-template"
91247
+ "format": "uri-template",
91248
+ "deprecated": true
91148
91249
  },
91149
91250
  "issue_search_url": {
91150
91251
  "type": "string",
@@ -91240,7 +91341,6 @@
91240
91341
  "followers_url",
91241
91342
  "following_url",
91242
91343
  "gists_url",
91243
- "hub_url",
91244
91344
  "issue_search_url",
91245
91345
  "issues_url",
91246
91346
  "keys_url",
@@ -103992,6 +104092,43 @@
103992
104092
  }
103993
104093
  }
103994
104094
  },
104095
+ "repository-rule-params-code-scanning-threshold": {
104096
+ "title": "CodeScanningThreshold",
104097
+ "description": "A tool and its thresholds.",
104098
+ "type": "object",
104099
+ "properties": {
104100
+ "alerts": {
104101
+ "type": "string",
104102
+ "description": "Code scanning alert threshold",
104103
+ "enum": [
104104
+ "none",
104105
+ "errors",
104106
+ "errors_and_warnings",
104107
+ "all"
104108
+ ]
104109
+ },
104110
+ "security_alerts": {
104111
+ "type": "string",
104112
+ "description": "Code scanning security alert threshold.",
104113
+ "enum": [
104114
+ "none",
104115
+ "critical",
104116
+ "high_or_higher",
104117
+ "medium_or_higher",
104118
+ "all"
104119
+ ]
104120
+ },
104121
+ "tool": {
104122
+ "type": "string",
104123
+ "description": "The name of a code scanning tool"
104124
+ }
104125
+ },
104126
+ "required": [
104127
+ "alerts",
104128
+ "security_alerts",
104129
+ "tool"
104130
+ ]
104131
+ },
103995
104132
  "repository-rule": {
103996
104133
  "title": "Repository Rule",
103997
104134
  "type": "object",
@@ -106277,7 +106414,9 @@
106277
106414
  "queued",
106278
106415
  "in_progress",
106279
106416
  "completed",
106280
- "waiting"
106417
+ "waiting",
106418
+ "requested",
106419
+ "pending"
106281
106420
  ]
106282
106421
  },
106283
106422
  "conclusion": {
@@ -108810,13 +108949,16 @@
108810
108949
  "nullable": true
108811
108950
  },
108812
108951
  "status": {
108813
- "description": "The phase of the lifecycle that the check is currently in.",
108952
+ "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.",
108814
108953
  "example": "queued",
108815
108954
  "type": "string",
108816
108955
  "enum": [
108817
108956
  "queued",
108818
108957
  "in_progress",
108819
- "completed"
108958
+ "completed",
108959
+ "waiting",
108960
+ "requested",
108961
+ "pending"
108820
108962
  ]
108821
108963
  },
108822
108964
  "conclusion": {
@@ -109094,11 +109236,15 @@
109094
109236
  },
109095
109237
  "status": {
109096
109238
  "type": "string",
109239
+ "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.",
109097
109240
  "example": "completed",
109098
109241
  "enum": [
109099
109242
  "queued",
109100
109243
  "in_progress",
109101
- "completed"
109244
+ "completed",
109245
+ "waiting",
109246
+ "requested",
109247
+ "pending"
109102
109248
  ],
109103
109249
  "nullable": true
109104
109250
  },
@@ -173448,6 +173594,7 @@
173448
173594
  "type": "object",
173449
173595
  "properties": {
173450
173596
  "permission": {
173597
+ "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.",
173451
173598
  "type": "object",
173452
173599
  "properties": {
173453
173600
  "to": {
@@ -173462,6 +173609,18 @@
173462
173609
  "required": [
173463
173610
  "to"
173464
173611
  ]
173612
+ },
173613
+ "role_name": {
173614
+ "description": "The role assigned to the collaborator.",
173615
+ "type": "object",
173616
+ "properties": {
173617
+ "to": {
173618
+ "type": "string"
173619
+ }
173620
+ },
173621
+ "required": [
173622
+ "to"
173623
+ ]
173465
173624
  }
173466
173625
  }
173467
173626
  },
@@ -252008,7 +252167,7 @@
252008
252167
  "type": "string"
252009
252168
  },
252010
252169
  "commits": {
252011
- "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.12/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.",
252170
+ "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.12/rest/commits) to fetch additional commits.",
252012
252171
  "type": "array",
252013
252172
  "items": {
252014
252173
  "title": "Commit",
@@ -257828,9 +257987,7 @@
257828
257987
  "properties": {
257829
257988
  "action": {
257830
257989
  "type": "string",
257831
- "enum": [
257832
- "sample.collected"
257833
- ]
257990
+ "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
257834
257991
  },
257835
257992
  "branch": {
257836
257993
  "type": "string"
@@ -257838,7 +257995,8 @@
257838
257995
  "client_payload": {
257839
257996
  "type": "object",
257840
257997
  "nullable": true,
257841
- "additionalProperties": true
257998
+ "additionalProperties": true,
257999
+ "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
257842
258000
  },
257843
258001
  "enterprise": {
257844
258002
  "$ref": "#/components/schemas/enterprise-webhooks"
@@ -295677,6 +295835,20 @@
295677
295835
  "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b"
295678
295836
  }
295679
295837
  },
295838
+ {
295839
+ "type": "wiki_commit",
295840
+ "details": {
295841
+ "path": "/example/Home.md",
295842
+ "start_line": 1,
295843
+ "end_line": 1,
295844
+ "start_column": 1,
295845
+ "end_column": 64,
295846
+ "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b",
295847
+ "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5",
295848
+ "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5",
295849
+ "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
295850
+ }
295851
+ },
295680
295852
  {
295681
295853
  "type": "issue_title",
295682
295854
  "details": {
@@ -302251,7 +302423,7 @@
302251
302423
  },
302252
302424
  "workflow-run-status": {
302253
302425
  "name": "status",
302254
- "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`.",
302426
+ "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`.",
302255
302427
  "in": "query",
302256
302428
  "required": false,
302257
302429
  "schema": {
@@ -302505,6 +302677,17 @@
302505
302677
  "type": "integer"
302506
302678
  }
302507
302679
  },
302680
+ "git-ref-only": {
302681
+ "name": "ref",
302682
+ "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.",
302683
+ "in": "path",
302684
+ "required": true,
302685
+ "example": "heads/feature-a",
302686
+ "schema": {
302687
+ "type": "string"
302688
+ },
302689
+ "x-multi-segment": true
302690
+ },
302508
302691
  "invitation-id": {
302509
302692
  "name": "invitation_id",
302510
302693
  "description": "The unique identifier of the invitation.",
@@ -303117,6 +303300,16 @@
303117
303300
  }
303118
303301
  }
303119
303302
  },
303303
+ "unacceptable": {
303304
+ "description": "Unacceptable",
303305
+ "content": {
303306
+ "application/json": {
303307
+ "schema": {
303308
+ "$ref": "#/components/schemas/basic-error"
303309
+ }
303310
+ }
303311
+ }
303312
+ },
303120
303313
  "scim_bad_request": {
303121
303314
  "description": "Bad request",
303122
303315
  "content": {