@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": {
@@ -8002,7 +8002,6 @@
8002
8002
  "default": {
8003
8003
  "value": {
8004
8004
  "advanced_security_enabled_for_new_repositories": true,
8005
- "advanced_security_enabled_new_user_namespace_repos": true,
8006
8005
  "dependabot_alerts_enabled_for_new_repositories": true,
8007
8006
  "secret_scanning_enabled_for_new_repositories": true,
8008
8007
  "secret_scanning_push_protection_enabled_for_new_repositories": true,
@@ -8365,7 +8364,7 @@
8365
8364
  "/feeds": {
8366
8365
  "get": {
8367
8366
  "summary": "Get feeds",
8368
- "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.9/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.9/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
8367
+ "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.9/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.9/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.9/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
8369
8368
  "tags": [
8370
8369
  "activity"
8371
8370
  ],
@@ -11085,7 +11084,7 @@
11085
11084
  "/organizations": {
11086
11085
  "get": {
11087
11086
  "summary": "List organizations",
11088
- "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.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
11087
+ "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.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
11089
11088
  "tags": [
11090
11089
  "orgs"
11091
11090
  ],
@@ -15989,7 +15988,7 @@
15989
15988
  "/orgs/{org}/hooks": {
15990
15989
  "get": {
15991
15990
  "summary": "List organization webhooks",
15992
- "description": "",
15991
+ "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
15993
15992
  "tags": [
15994
15993
  "orgs"
15995
15994
  ],
@@ -16047,7 +16046,7 @@
16047
16046
  },
16048
16047
  "post": {
16049
16048
  "summary": "Create an organization webhook",
16050
- "description": "Here's how you can create a hook that posts payloads in JSON format:",
16049
+ "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or \nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16051
16050
  "tags": [
16052
16051
  "orgs"
16053
16052
  ],
@@ -16184,7 +16183,7 @@
16184
16183
  "/orgs/{org}/hooks/{hook_id}": {
16185
16184
  "get": {
16186
16185
  "summary": "Get an organization webhook",
16187
- "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).\"",
16186
+ "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16188
16187
  "tags": [
16189
16188
  "orgs"
16190
16189
  ],
@@ -16231,7 +16230,7 @@
16231
16230
  },
16232
16231
  "patch": {
16233
16232
  "summary": "Update an organization webhook",
16234
- "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).\"",
16233
+ "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16235
16234
  "tags": [
16236
16235
  "orgs"
16237
16236
  ],
@@ -16343,7 +16342,7 @@
16343
16342
  },
16344
16343
  "delete": {
16345
16344
  "summary": "Delete an organization webhook",
16346
- "description": "",
16345
+ "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16347
16346
  "tags": [
16348
16347
  "orgs"
16349
16348
  ],
@@ -16380,7 +16379,7 @@
16380
16379
  "/orgs/{org}/hooks/{hook_id}/config": {
16381
16380
  "get": {
16382
16381
  "summary": "Get a webhook configuration for an organization",
16383
- "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.",
16382
+ "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16384
16383
  "tags": [
16385
16384
  "orgs"
16386
16385
  ],
@@ -16424,7 +16423,7 @@
16424
16423
  },
16425
16424
  "patch": {
16426
16425
  "summary": "Update a webhook configuration for an organization",
16427
- "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.",
16426
+ "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16428
16427
  "tags": [
16429
16428
  "orgs"
16430
16429
  ],
@@ -16505,7 +16504,7 @@
16505
16504
  "/orgs/{org}/hooks/{hook_id}/deliveries": {
16506
16505
  "get": {
16507
16506
  "summary": "List deliveries for an organization webhook",
16508
- "description": "Returns a list of webhook deliveries for a webhook configured in an organization.",
16507
+ "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16509
16508
  "tags": [
16510
16509
  "orgs"
16511
16510
  ],
@@ -16574,7 +16573,7 @@
16574
16573
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
16575
16574
  "get": {
16576
16575
  "summary": "Get a webhook delivery for an organization webhook",
16577
- "description": "Returns a delivery for a webhook configured in an organization.",
16576
+ "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16578
16577
  "tags": [
16579
16578
  "orgs"
16580
16579
  ],
@@ -16629,7 +16628,7 @@
16629
16628
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
16630
16629
  "post": {
16631
16630
  "summary": "Redeliver a delivery for an organization webhook",
16632
- "description": "Redeliver a delivery for a webhook configured in an organization.",
16631
+ "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16633
16632
  "tags": [
16634
16633
  "orgs"
16635
16634
  ],
@@ -16672,7 +16671,7 @@
16672
16671
  "/orgs/{org}/hooks/{hook_id}/pings": {
16673
16672
  "post": {
16674
16673
  "summary": "Ping an organization webhook",
16675
- "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the hook.",
16674
+ "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
16676
16675
  "tags": [
16677
16676
  "orgs"
16678
16677
  ],
@@ -25903,7 +25902,7 @@
25903
25902
  "/repos/{owner}/{repo}/actions/runs": {
25904
25903
  "get": {
25905
25904
  "summary": "List workflow runs for a repository",
25906
- "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.9/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.",
25905
+ "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.9/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`.",
25907
25906
  "tags": [
25908
25907
  "actions"
25909
25908
  ],
@@ -31437,11 +31436,14 @@
31437
31436
  },
31438
31437
  "status": {
31439
31438
  "type": "string",
31440
- "description": "The current status.",
31439
+ "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
31441
31440
  "enum": [
31442
31441
  "queued",
31443
31442
  "in_progress",
31444
- "completed"
31443
+ "completed",
31444
+ "waiting",
31445
+ "requested",
31446
+ "pending"
31445
31447
  ]
31446
31448
  },
31447
31449
  "conclusion": {
@@ -34088,6 +34090,9 @@
34088
34090
  }
34089
34091
  }
34090
34092
  },
34093
+ "409": {
34094
+ "$ref": "#/components/responses/conflict"
34095
+ },
34091
34096
  "422": {
34092
34097
  "$ref": "#/components/responses/validation_failed"
34093
34098
  }
@@ -34319,6 +34324,9 @@
34319
34324
  "$ref": "#/components/headers/link"
34320
34325
  }
34321
34326
  }
34327
+ },
34328
+ "409": {
34329
+ "$ref": "#/components/responses/conflict"
34322
34330
  }
34323
34331
  },
34324
34332
  "x-github": {
@@ -34378,6 +34386,9 @@
34378
34386
  "404": {
34379
34387
  "$ref": "#/components/responses/not_found"
34380
34388
  },
34389
+ "409": {
34390
+ "$ref": "#/components/responses/conflict"
34391
+ },
34381
34392
  "422": {
34382
34393
  "$ref": "#/components/responses/validation_failed"
34383
34394
  },
@@ -34715,7 +34726,7 @@
34715
34726
  "/repos/{owner}/{repo}/compare/{basehead}": {
34716
34727
  "get": {
34717
34728
  "summary": "Compare two commits",
34718
- "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.9/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.9/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.9/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. |",
34729
+ "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.9/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.9/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.9/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. |",
34719
34730
  "tags": [
34720
34731
  "repos"
34721
34732
  ],
@@ -36735,6 +36746,9 @@
36735
36746
  "204": {
36736
36747
  "description": "Response"
36737
36748
  },
36749
+ "404": {
36750
+ "$ref": "#/components/responses/not_found"
36751
+ },
36738
36752
  "422": {
36739
36753
  "$ref": "#/components/responses/validation_failed"
36740
36754
  }
@@ -37322,6 +37336,616 @@
37322
37336
  "x-octokit": {}
37323
37337
  }
37324
37338
  },
37339
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
37340
+ "get": {
37341
+ "summary": "List environment secrets",
37342
+ "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.",
37343
+ "tags": [
37344
+ "actions"
37345
+ ],
37346
+ "operationId": "actions/list-environment-secrets",
37347
+ "externalDocs": {
37348
+ "description": "API method documentation",
37349
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-environment-secrets"
37350
+ },
37351
+ "parameters": [
37352
+ {
37353
+ "$ref": "#/components/parameters/owner"
37354
+ },
37355
+ {
37356
+ "$ref": "#/components/parameters/repo"
37357
+ },
37358
+ {
37359
+ "$ref": "#/components/parameters/environment-name"
37360
+ },
37361
+ {
37362
+ "$ref": "#/components/parameters/per-page"
37363
+ },
37364
+ {
37365
+ "$ref": "#/components/parameters/page"
37366
+ }
37367
+ ],
37368
+ "responses": {
37369
+ "200": {
37370
+ "description": "Response",
37371
+ "content": {
37372
+ "application/json": {
37373
+ "schema": {
37374
+ "type": "object",
37375
+ "required": [
37376
+ "total_count",
37377
+ "secrets"
37378
+ ],
37379
+ "properties": {
37380
+ "total_count": {
37381
+ "type": "integer"
37382
+ },
37383
+ "secrets": {
37384
+ "type": "array",
37385
+ "items": {
37386
+ "$ref": "#/components/schemas/actions-secret"
37387
+ }
37388
+ }
37389
+ }
37390
+ },
37391
+ "examples": {
37392
+ "default": {
37393
+ "$ref": "#/components/examples/actions-secret-paginated"
37394
+ }
37395
+ }
37396
+ }
37397
+ },
37398
+ "headers": {
37399
+ "Link": {
37400
+ "$ref": "#/components/headers/link"
37401
+ }
37402
+ }
37403
+ }
37404
+ },
37405
+ "x-github": {
37406
+ "githubCloudOnly": false,
37407
+ "enabledForGitHubApps": true,
37408
+ "category": "actions",
37409
+ "subcategory": "secrets"
37410
+ },
37411
+ "x-octokit": {}
37412
+ }
37413
+ },
37414
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
37415
+ "get": {
37416
+ "summary": "Get an environment public key",
37417
+ "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.",
37418
+ "tags": [
37419
+ "actions"
37420
+ ],
37421
+ "operationId": "actions/get-environment-public-key",
37422
+ "externalDocs": {
37423
+ "description": "API method documentation",
37424
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-public-key"
37425
+ },
37426
+ "parameters": [
37427
+ {
37428
+ "$ref": "#/components/parameters/owner"
37429
+ },
37430
+ {
37431
+ "$ref": "#/components/parameters/repo"
37432
+ },
37433
+ {
37434
+ "$ref": "#/components/parameters/environment-name"
37435
+ }
37436
+ ],
37437
+ "responses": {
37438
+ "200": {
37439
+ "description": "Response",
37440
+ "content": {
37441
+ "application/json": {
37442
+ "schema": {
37443
+ "$ref": "#/components/schemas/actions-public-key"
37444
+ },
37445
+ "examples": {
37446
+ "default": {
37447
+ "$ref": "#/components/examples/actions-public-key"
37448
+ }
37449
+ }
37450
+ }
37451
+ }
37452
+ }
37453
+ },
37454
+ "x-github": {
37455
+ "githubCloudOnly": false,
37456
+ "enabledForGitHubApps": true,
37457
+ "category": "actions",
37458
+ "subcategory": "secrets"
37459
+ },
37460
+ "x-octokit": {}
37461
+ }
37462
+ },
37463
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
37464
+ "get": {
37465
+ "summary": "Get an environment secret",
37466
+ "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.",
37467
+ "tags": [
37468
+ "actions"
37469
+ ],
37470
+ "operationId": "actions/get-environment-secret",
37471
+ "externalDocs": {
37472
+ "description": "API method documentation",
37473
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-secret"
37474
+ },
37475
+ "parameters": [
37476
+ {
37477
+ "$ref": "#/components/parameters/owner"
37478
+ },
37479
+ {
37480
+ "$ref": "#/components/parameters/repo"
37481
+ },
37482
+ {
37483
+ "$ref": "#/components/parameters/environment-name"
37484
+ },
37485
+ {
37486
+ "$ref": "#/components/parameters/secret-name"
37487
+ }
37488
+ ],
37489
+ "responses": {
37490
+ "200": {
37491
+ "description": "Response",
37492
+ "content": {
37493
+ "application/json": {
37494
+ "schema": {
37495
+ "$ref": "#/components/schemas/actions-secret"
37496
+ },
37497
+ "examples": {
37498
+ "default": {
37499
+ "$ref": "#/components/examples/actions-secret"
37500
+ }
37501
+ }
37502
+ }
37503
+ }
37504
+ }
37505
+ },
37506
+ "x-github": {
37507
+ "githubCloudOnly": false,
37508
+ "enabledForGitHubApps": true,
37509
+ "category": "actions",
37510
+ "subcategory": "secrets"
37511
+ },
37512
+ "x-octokit": {}
37513
+ },
37514
+ "put": {
37515
+ "summary": "Create or update an environment secret",
37516
+ "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.9/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.",
37517
+ "tags": [
37518
+ "actions"
37519
+ ],
37520
+ "operationId": "actions/create-or-update-environment-secret",
37521
+ "externalDocs": {
37522
+ "description": "API method documentation",
37523
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-environment-secret"
37524
+ },
37525
+ "parameters": [
37526
+ {
37527
+ "$ref": "#/components/parameters/owner"
37528
+ },
37529
+ {
37530
+ "$ref": "#/components/parameters/repo"
37531
+ },
37532
+ {
37533
+ "$ref": "#/components/parameters/environment-name"
37534
+ },
37535
+ {
37536
+ "$ref": "#/components/parameters/secret-name"
37537
+ }
37538
+ ],
37539
+ "requestBody": {
37540
+ "required": true,
37541
+ "content": {
37542
+ "application/json": {
37543
+ "schema": {
37544
+ "type": "object",
37545
+ "properties": {
37546
+ "encrypted_value": {
37547
+ "type": "string",
37548
+ "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.9/rest/actions/secrets#get-an-environment-public-key) endpoint.",
37549
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
37550
+ },
37551
+ "key_id": {
37552
+ "type": "string",
37553
+ "description": "ID of the key you used to encrypt the secret."
37554
+ }
37555
+ },
37556
+ "required": [
37557
+ "encrypted_value",
37558
+ "key_id"
37559
+ ]
37560
+ },
37561
+ "examples": {
37562
+ "default": {
37563
+ "value": {
37564
+ "encrypted_value": "c2VjcmV0",
37565
+ "key_id": "012345678912345678"
37566
+ }
37567
+ }
37568
+ }
37569
+ }
37570
+ }
37571
+ },
37572
+ "responses": {
37573
+ "201": {
37574
+ "description": "Response when creating a secret",
37575
+ "content": {
37576
+ "application/json": {
37577
+ "schema": {
37578
+ "$ref": "#/components/schemas/empty-object"
37579
+ },
37580
+ "examples": {
37581
+ "default": {
37582
+ "value": null
37583
+ }
37584
+ }
37585
+ }
37586
+ }
37587
+ },
37588
+ "204": {
37589
+ "description": "Response when updating a secret"
37590
+ }
37591
+ },
37592
+ "x-github": {
37593
+ "githubCloudOnly": false,
37594
+ "enabledForGitHubApps": true,
37595
+ "category": "actions",
37596
+ "subcategory": "secrets"
37597
+ },
37598
+ "x-octokit": {}
37599
+ },
37600
+ "delete": {
37601
+ "summary": "Delete an environment secret",
37602
+ "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.",
37603
+ "tags": [
37604
+ "actions"
37605
+ ],
37606
+ "operationId": "actions/delete-environment-secret",
37607
+ "externalDocs": {
37608
+ "description": "API method documentation",
37609
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#delete-an-environment-secret"
37610
+ },
37611
+ "parameters": [
37612
+ {
37613
+ "$ref": "#/components/parameters/owner"
37614
+ },
37615
+ {
37616
+ "$ref": "#/components/parameters/repo"
37617
+ },
37618
+ {
37619
+ "$ref": "#/components/parameters/environment-name"
37620
+ },
37621
+ {
37622
+ "$ref": "#/components/parameters/secret-name"
37623
+ }
37624
+ ],
37625
+ "responses": {
37626
+ "204": {
37627
+ "description": "Default response"
37628
+ }
37629
+ },
37630
+ "x-github": {
37631
+ "githubCloudOnly": false,
37632
+ "enabledForGitHubApps": true,
37633
+ "category": "actions",
37634
+ "subcategory": "secrets"
37635
+ },
37636
+ "x-octokit": {}
37637
+ }
37638
+ },
37639
+ "/repos/{owner}/{repo}/environments/{environment_name}/variables": {
37640
+ "get": {
37641
+ "summary": "List environment variables",
37642
+ "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.",
37643
+ "tags": [
37644
+ "actions"
37645
+ ],
37646
+ "operationId": "actions/list-environment-variables",
37647
+ "externalDocs": {
37648
+ "description": "API method documentation",
37649
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#list-environment-variables"
37650
+ },
37651
+ "parameters": [
37652
+ {
37653
+ "$ref": "#/components/parameters/owner"
37654
+ },
37655
+ {
37656
+ "$ref": "#/components/parameters/repo"
37657
+ },
37658
+ {
37659
+ "$ref": "#/components/parameters/environment-name"
37660
+ },
37661
+ {
37662
+ "$ref": "#/components/parameters/variables-per-page"
37663
+ },
37664
+ {
37665
+ "$ref": "#/components/parameters/page"
37666
+ }
37667
+ ],
37668
+ "responses": {
37669
+ "200": {
37670
+ "description": "Response",
37671
+ "content": {
37672
+ "application/json": {
37673
+ "schema": {
37674
+ "type": "object",
37675
+ "required": [
37676
+ "total_count",
37677
+ "variables"
37678
+ ],
37679
+ "properties": {
37680
+ "total_count": {
37681
+ "type": "integer"
37682
+ },
37683
+ "variables": {
37684
+ "type": "array",
37685
+ "items": {
37686
+ "$ref": "#/components/schemas/actions-variable"
37687
+ }
37688
+ }
37689
+ }
37690
+ },
37691
+ "examples": {
37692
+ "default": {
37693
+ "$ref": "#/components/examples/actions-variables-paginated"
37694
+ }
37695
+ }
37696
+ }
37697
+ },
37698
+ "headers": {
37699
+ "Link": {
37700
+ "$ref": "#/components/headers/link"
37701
+ }
37702
+ }
37703
+ }
37704
+ },
37705
+ "x-github": {
37706
+ "githubCloudOnly": false,
37707
+ "enabledForGitHubApps": true,
37708
+ "category": "actions",
37709
+ "subcategory": "variables"
37710
+ },
37711
+ "x-octokit": {}
37712
+ },
37713
+ "post": {
37714
+ "summary": "Create an environment variable",
37715
+ "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.",
37716
+ "tags": [
37717
+ "actions"
37718
+ ],
37719
+ "operationId": "actions/create-environment-variable",
37720
+ "externalDocs": {
37721
+ "description": "API method documentation",
37722
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#create-an-environment-variable"
37723
+ },
37724
+ "parameters": [
37725
+ {
37726
+ "$ref": "#/components/parameters/owner"
37727
+ },
37728
+ {
37729
+ "$ref": "#/components/parameters/repo"
37730
+ },
37731
+ {
37732
+ "$ref": "#/components/parameters/environment-name"
37733
+ }
37734
+ ],
37735
+ "requestBody": {
37736
+ "required": true,
37737
+ "content": {
37738
+ "application/json": {
37739
+ "schema": {
37740
+ "type": "object",
37741
+ "properties": {
37742
+ "name": {
37743
+ "type": "string",
37744
+ "description": "The name of the variable."
37745
+ },
37746
+ "value": {
37747
+ "type": "string",
37748
+ "description": "The value of the variable."
37749
+ }
37750
+ },
37751
+ "required": [
37752
+ "name",
37753
+ "value"
37754
+ ]
37755
+ },
37756
+ "examples": {
37757
+ "default": {
37758
+ "value": {
37759
+ "name": "USERNAME",
37760
+ "value": "octocat"
37761
+ }
37762
+ }
37763
+ }
37764
+ }
37765
+ }
37766
+ },
37767
+ "responses": {
37768
+ "201": {
37769
+ "description": "Response",
37770
+ "content": {
37771
+ "application/json": {
37772
+ "schema": {
37773
+ "$ref": "#/components/schemas/empty-object"
37774
+ },
37775
+ "examples": {
37776
+ "default": {
37777
+ "value": null
37778
+ }
37779
+ }
37780
+ }
37781
+ }
37782
+ }
37783
+ },
37784
+ "x-github": {
37785
+ "githubCloudOnly": false,
37786
+ "enabledForGitHubApps": true,
37787
+ "category": "actions",
37788
+ "subcategory": "variables"
37789
+ },
37790
+ "x-octokit": {}
37791
+ }
37792
+ },
37793
+ "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
37794
+ "get": {
37795
+ "summary": "Get an environment variable",
37796
+ "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.",
37797
+ "tags": [
37798
+ "actions"
37799
+ ],
37800
+ "operationId": "actions/get-environment-variable",
37801
+ "externalDocs": {
37802
+ "description": "API method documentation",
37803
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#get-an-environment-variable"
37804
+ },
37805
+ "parameters": [
37806
+ {
37807
+ "$ref": "#/components/parameters/owner"
37808
+ },
37809
+ {
37810
+ "$ref": "#/components/parameters/repo"
37811
+ },
37812
+ {
37813
+ "$ref": "#/components/parameters/environment-name"
37814
+ },
37815
+ {
37816
+ "$ref": "#/components/parameters/variable-name"
37817
+ }
37818
+ ],
37819
+ "responses": {
37820
+ "200": {
37821
+ "description": "Response",
37822
+ "content": {
37823
+ "application/json": {
37824
+ "schema": {
37825
+ "$ref": "#/components/schemas/actions-variable"
37826
+ },
37827
+ "examples": {
37828
+ "default": {
37829
+ "$ref": "#/components/examples/actions-variable"
37830
+ }
37831
+ }
37832
+ }
37833
+ }
37834
+ }
37835
+ },
37836
+ "x-github": {
37837
+ "githubCloudOnly": false,
37838
+ "enabledForGitHubApps": true,
37839
+ "category": "actions",
37840
+ "subcategory": "variables"
37841
+ },
37842
+ "x-octokit": {}
37843
+ },
37844
+ "patch": {
37845
+ "summary": "Update an environment variable",
37846
+ "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.",
37847
+ "tags": [
37848
+ "actions"
37849
+ ],
37850
+ "operationId": "actions/update-environment-variable",
37851
+ "externalDocs": {
37852
+ "description": "API method documentation",
37853
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#update-an-environment-variable"
37854
+ },
37855
+ "parameters": [
37856
+ {
37857
+ "$ref": "#/components/parameters/owner"
37858
+ },
37859
+ {
37860
+ "$ref": "#/components/parameters/repo"
37861
+ },
37862
+ {
37863
+ "$ref": "#/components/parameters/variable-name"
37864
+ },
37865
+ {
37866
+ "$ref": "#/components/parameters/environment-name"
37867
+ }
37868
+ ],
37869
+ "requestBody": {
37870
+ "required": true,
37871
+ "content": {
37872
+ "application/json": {
37873
+ "schema": {
37874
+ "type": "object",
37875
+ "properties": {
37876
+ "name": {
37877
+ "type": "string",
37878
+ "description": "The name of the variable."
37879
+ },
37880
+ "value": {
37881
+ "type": "string",
37882
+ "description": "The value of the variable."
37883
+ }
37884
+ }
37885
+ },
37886
+ "examples": {
37887
+ "default": {
37888
+ "value": {
37889
+ "name": "USERNAME",
37890
+ "value": "octocat"
37891
+ }
37892
+ }
37893
+ }
37894
+ }
37895
+ }
37896
+ },
37897
+ "responses": {
37898
+ "204": {
37899
+ "description": "Response"
37900
+ }
37901
+ },
37902
+ "x-github": {
37903
+ "githubCloudOnly": false,
37904
+ "enabledForGitHubApps": true,
37905
+ "category": "actions",
37906
+ "subcategory": "variables"
37907
+ },
37908
+ "x-octokit": {}
37909
+ },
37910
+ "delete": {
37911
+ "summary": "Delete an environment variable",
37912
+ "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.",
37913
+ "tags": [
37914
+ "actions"
37915
+ ],
37916
+ "operationId": "actions/delete-environment-variable",
37917
+ "externalDocs": {
37918
+ "description": "API method documentation",
37919
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#delete-an-environment-variable"
37920
+ },
37921
+ "parameters": [
37922
+ {
37923
+ "$ref": "#/components/parameters/owner"
37924
+ },
37925
+ {
37926
+ "$ref": "#/components/parameters/repo"
37927
+ },
37928
+ {
37929
+ "$ref": "#/components/parameters/variable-name"
37930
+ },
37931
+ {
37932
+ "$ref": "#/components/parameters/environment-name"
37933
+ }
37934
+ ],
37935
+ "responses": {
37936
+ "204": {
37937
+ "description": "Response"
37938
+ }
37939
+ },
37940
+ "x-github": {
37941
+ "githubCloudOnly": false,
37942
+ "enabledForGitHubApps": true,
37943
+ "category": "actions",
37944
+ "subcategory": "variables"
37945
+ },
37946
+ "x-octokit": {}
37947
+ }
37948
+ },
37325
37949
  "/repos/{owner}/{repo}/events": {
37326
37950
  "get": {
37327
37951
  "summary": "List repository events",
@@ -37694,6 +38318,9 @@
37694
38318
  "404": {
37695
38319
  "$ref": "#/components/responses/not_found"
37696
38320
  },
38321
+ "409": {
38322
+ "$ref": "#/components/responses/conflict"
38323
+ },
37697
38324
  "422": {
37698
38325
  "$ref": "#/components/responses/validation_failed"
37699
38326
  }
@@ -37848,6 +38475,9 @@
37848
38475
  "404": {
37849
38476
  "$ref": "#/components/responses/not_found"
37850
38477
  },
38478
+ "409": {
38479
+ "$ref": "#/components/responses/conflict"
38480
+ },
37851
38481
  "422": {
37852
38482
  "$ref": "#/components/responses/validation_failed"
37853
38483
  }
@@ -37902,6 +38532,9 @@
37902
38532
  },
37903
38533
  "404": {
37904
38534
  "$ref": "#/components/responses/not_found"
38535
+ },
38536
+ "409": {
38537
+ "$ref": "#/components/responses/conflict"
37905
38538
  }
37906
38539
  },
37907
38540
  "x-github": {
@@ -37933,7 +38566,7 @@
37933
38566
  "$ref": "#/components/parameters/repo"
37934
38567
  },
37935
38568
  {
37936
- "$ref": "#/components/parameters/commit-ref"
38569
+ "$ref": "#/components/parameters/git-ref-only"
37937
38570
  }
37938
38571
  ],
37939
38572
  "responses": {
@@ -37959,6 +38592,9 @@
37959
38592
  "$ref": "#/components/headers/link"
37960
38593
  }
37961
38594
  }
38595
+ },
38596
+ "409": {
38597
+ "$ref": "#/components/responses/conflict"
37962
38598
  }
37963
38599
  },
37964
38600
  "x-github": {
@@ -37990,7 +38626,7 @@
37990
38626
  "$ref": "#/components/parameters/repo"
37991
38627
  },
37992
38628
  {
37993
- "$ref": "#/components/parameters/commit-ref"
38629
+ "$ref": "#/components/parameters/git-ref-only"
37994
38630
  }
37995
38631
  ],
37996
38632
  "responses": {
@@ -38011,6 +38647,9 @@
38011
38647
  },
38012
38648
  "404": {
38013
38649
  "$ref": "#/components/responses/not_found"
38650
+ },
38651
+ "409": {
38652
+ "$ref": "#/components/responses/conflict"
38014
38653
  }
38015
38654
  },
38016
38655
  "x-github": {
@@ -38098,6 +38737,9 @@
38098
38737
  }
38099
38738
  }
38100
38739
  },
38740
+ "409": {
38741
+ "$ref": "#/components/responses/conflict"
38742
+ },
38101
38743
  "422": {
38102
38744
  "$ref": "#/components/responses/validation_failed"
38103
38745
  }
@@ -38114,7 +38756,7 @@
38114
38756
  "/repos/{owner}/{repo}/git/refs/{ref}": {
38115
38757
  "patch": {
38116
38758
  "summary": "Update a reference",
38117
- "description": "",
38759
+ "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.",
38118
38760
  "tags": [
38119
38761
  "git"
38120
38762
  ],
@@ -38131,15 +38773,7 @@
38131
38773
  "$ref": "#/components/parameters/repo"
38132
38774
  },
38133
38775
  {
38134
- "name": "ref",
38135
- "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.",
38136
- "in": "path",
38137
- "required": true,
38138
- "example": "heads/featureA",
38139
- "schema": {
38140
- "type": "string"
38141
- },
38142
- "x-multi-segment": true
38776
+ "$ref": "#/components/parameters/git-ref-only"
38143
38777
  }
38144
38778
  ],
38145
38779
  "requestBody": {
@@ -38190,6 +38824,9 @@
38190
38824
  }
38191
38825
  }
38192
38826
  },
38827
+ "409": {
38828
+ "$ref": "#/components/responses/conflict"
38829
+ },
38193
38830
  "422": {
38194
38831
  "$ref": "#/components/responses/validation_failed"
38195
38832
  }
@@ -38204,7 +38841,7 @@
38204
38841
  },
38205
38842
  "delete": {
38206
38843
  "summary": "Delete a reference",
38207
- "description": "",
38844
+ "description": "Deletes the provided reference.",
38208
38845
  "tags": [
38209
38846
  "git"
38210
38847
  ],
@@ -38221,13 +38858,16 @@
38221
38858
  "$ref": "#/components/parameters/repo"
38222
38859
  },
38223
38860
  {
38224
- "$ref": "#/components/parameters/commit-ref"
38861
+ "$ref": "#/components/parameters/git-ref-only"
38225
38862
  }
38226
38863
  ],
38227
38864
  "responses": {
38228
38865
  "204": {
38229
38866
  "description": "Response"
38230
38867
  },
38868
+ "409": {
38869
+ "$ref": "#/components/responses/conflict"
38870
+ },
38231
38871
  "422": {
38232
38872
  "$ref": "#/components/responses/validation_failed"
38233
38873
  }
@@ -38362,6 +39002,9 @@
38362
39002
  }
38363
39003
  }
38364
39004
  },
39005
+ "409": {
39006
+ "$ref": "#/components/responses/conflict"
39007
+ },
38365
39008
  "422": {
38366
39009
  "$ref": "#/components/responses/validation_failed"
38367
39010
  }
@@ -38421,6 +39064,9 @@
38421
39064
  },
38422
39065
  "404": {
38423
39066
  "$ref": "#/components/responses/not_found"
39067
+ },
39068
+ "409": {
39069
+ "$ref": "#/components/responses/conflict"
38424
39070
  }
38425
39071
  },
38426
39072
  "x-github": {
@@ -38558,6 +39204,9 @@
38558
39204
  "404": {
38559
39205
  "$ref": "#/components/responses/not_found"
38560
39206
  },
39207
+ "409": {
39208
+ "$ref": "#/components/responses/conflict"
39209
+ },
38561
39210
  "422": {
38562
39211
  "$ref": "#/components/responses/validation_failed"
38563
39212
  }
@@ -38632,6 +39281,9 @@
38632
39281
  "404": {
38633
39282
  "$ref": "#/components/responses/not_found"
38634
39283
  },
39284
+ "409": {
39285
+ "$ref": "#/components/responses/conflict"
39286
+ },
38635
39287
  "422": {
38636
39288
  "$ref": "#/components/responses/validation_failed"
38637
39289
  }
@@ -45460,6 +46112,9 @@
45460
46112
  "404": {
45461
46113
  "$ref": "#/components/responses/not_found"
45462
46114
  },
46115
+ "406": {
46116
+ "$ref": "#/components/responses/unacceptable"
46117
+ },
45463
46118
  "500": {
45464
46119
  "$ref": "#/components/responses/internal_error"
45465
46120
  },
@@ -50495,587 +51150,7 @@
50495
51150
  "x-octokit": {}
50496
51151
  }
50497
51152
  },
50498
- "/repositories/{repository_id}/environments/{environment_name}/secrets": {
50499
- "get": {
50500
- "summary": "List environment secrets",
50501
- "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.",
50502
- "tags": [
50503
- "actions"
50504
- ],
50505
- "operationId": "actions/list-environment-secrets",
50506
- "externalDocs": {
50507
- "description": "API method documentation",
50508
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-environment-secrets"
50509
- },
50510
- "parameters": [
50511
- {
50512
- "$ref": "#/components/parameters/repository-id"
50513
- },
50514
- {
50515
- "$ref": "#/components/parameters/environment-name"
50516
- },
50517
- {
50518
- "$ref": "#/components/parameters/per-page"
50519
- },
50520
- {
50521
- "$ref": "#/components/parameters/page"
50522
- }
50523
- ],
50524
- "responses": {
50525
- "200": {
50526
- "description": "Response",
50527
- "content": {
50528
- "application/json": {
50529
- "schema": {
50530
- "type": "object",
50531
- "required": [
50532
- "total_count",
50533
- "secrets"
50534
- ],
50535
- "properties": {
50536
- "total_count": {
50537
- "type": "integer"
50538
- },
50539
- "secrets": {
50540
- "type": "array",
50541
- "items": {
50542
- "$ref": "#/components/schemas/actions-secret"
50543
- }
50544
- }
50545
- }
50546
- },
50547
- "examples": {
50548
- "default": {
50549
- "$ref": "#/components/examples/actions-secret-paginated"
50550
- }
50551
- }
50552
- }
50553
- },
50554
- "headers": {
50555
- "Link": {
50556
- "$ref": "#/components/headers/link"
50557
- }
50558
- }
50559
- }
50560
- },
50561
- "x-github": {
50562
- "githubCloudOnly": false,
50563
- "enabledForGitHubApps": true,
50564
- "category": "actions",
50565
- "subcategory": "secrets"
50566
- },
50567
- "x-octokit": {}
50568
- }
50569
- },
50570
- "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
50571
- "get": {
50572
- "summary": "Get an environment public key",
50573
- "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.",
50574
- "tags": [
50575
- "actions"
50576
- ],
50577
- "operationId": "actions/get-environment-public-key",
50578
- "externalDocs": {
50579
- "description": "API method documentation",
50580
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-public-key"
50581
- },
50582
- "parameters": [
50583
- {
50584
- "$ref": "#/components/parameters/repository-id"
50585
- },
50586
- {
50587
- "$ref": "#/components/parameters/environment-name"
50588
- }
50589
- ],
50590
- "responses": {
50591
- "200": {
50592
- "description": "Response",
50593
- "content": {
50594
- "application/json": {
50595
- "schema": {
50596
- "$ref": "#/components/schemas/actions-public-key"
50597
- },
50598
- "examples": {
50599
- "default": {
50600
- "$ref": "#/components/examples/actions-public-key"
50601
- }
50602
- }
50603
- }
50604
- }
50605
- }
50606
- },
50607
- "x-github": {
50608
- "githubCloudOnly": false,
50609
- "enabledForGitHubApps": true,
50610
- "category": "actions",
50611
- "subcategory": "secrets"
50612
- },
50613
- "x-octokit": {}
50614
- }
50615
- },
50616
- "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
50617
- "get": {
50618
- "summary": "Get an environment secret",
50619
- "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.",
50620
- "tags": [
50621
- "actions"
50622
- ],
50623
- "operationId": "actions/get-environment-secret",
50624
- "externalDocs": {
50625
- "description": "API method documentation",
50626
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-secret"
50627
- },
50628
- "parameters": [
50629
- {
50630
- "$ref": "#/components/parameters/repository-id"
50631
- },
50632
- {
50633
- "$ref": "#/components/parameters/environment-name"
50634
- },
50635
- {
50636
- "$ref": "#/components/parameters/secret-name"
50637
- }
50638
- ],
50639
- "responses": {
50640
- "200": {
50641
- "description": "Response",
50642
- "content": {
50643
- "application/json": {
50644
- "schema": {
50645
- "$ref": "#/components/schemas/actions-secret"
50646
- },
50647
- "examples": {
50648
- "default": {
50649
- "$ref": "#/components/examples/actions-secret"
50650
- }
50651
- }
50652
- }
50653
- }
50654
- }
50655
- },
50656
- "x-github": {
50657
- "githubCloudOnly": false,
50658
- "enabledForGitHubApps": true,
50659
- "category": "actions",
50660
- "subcategory": "secrets"
50661
- },
50662
- "x-octokit": {}
50663
- },
50664
- "put": {
50665
- "summary": "Create or update an environment secret",
50666
- "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.9/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.",
50667
- "tags": [
50668
- "actions"
50669
- ],
50670
- "operationId": "actions/create-or-update-environment-secret",
50671
- "externalDocs": {
50672
- "description": "API method documentation",
50673
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-environment-secret"
50674
- },
50675
- "parameters": [
50676
- {
50677
- "$ref": "#/components/parameters/repository-id"
50678
- },
50679
- {
50680
- "$ref": "#/components/parameters/environment-name"
50681
- },
50682
- {
50683
- "$ref": "#/components/parameters/secret-name"
50684
- }
50685
- ],
50686
- "requestBody": {
50687
- "required": true,
50688
- "content": {
50689
- "application/json": {
50690
- "schema": {
50691
- "type": "object",
50692
- "properties": {
50693
- "encrypted_value": {
50694
- "type": "string",
50695
- "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.9/rest/actions/secrets#get-an-environment-public-key) endpoint.",
50696
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
50697
- },
50698
- "key_id": {
50699
- "type": "string",
50700
- "description": "ID of the key you used to encrypt the secret."
50701
- }
50702
- },
50703
- "required": [
50704
- "encrypted_value",
50705
- "key_id"
50706
- ]
50707
- },
50708
- "examples": {
50709
- "default": {
50710
- "value": {
50711
- "encrypted_value": "c2VjcmV0",
50712
- "key_id": "012345678912345678"
50713
- }
50714
- }
50715
- }
50716
- }
50717
- }
50718
- },
50719
- "responses": {
50720
- "201": {
50721
- "description": "Response when creating a secret",
50722
- "content": {
50723
- "application/json": {
50724
- "schema": {
50725
- "$ref": "#/components/schemas/empty-object"
50726
- },
50727
- "examples": {
50728
- "default": {
50729
- "value": null
50730
- }
50731
- }
50732
- }
50733
- }
50734
- },
50735
- "204": {
50736
- "description": "Response when updating a secret"
50737
- }
50738
- },
50739
- "x-github": {
50740
- "githubCloudOnly": false,
50741
- "enabledForGitHubApps": true,
50742
- "category": "actions",
50743
- "subcategory": "secrets"
50744
- },
50745
- "x-octokit": {}
50746
- },
50747
- "delete": {
50748
- "summary": "Delete an environment secret",
50749
- "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.",
50750
- "tags": [
50751
- "actions"
50752
- ],
50753
- "operationId": "actions/delete-environment-secret",
50754
- "externalDocs": {
50755
- "description": "API method documentation",
50756
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#delete-an-environment-secret"
50757
- },
50758
- "parameters": [
50759
- {
50760
- "$ref": "#/components/parameters/repository-id"
50761
- },
50762
- {
50763
- "$ref": "#/components/parameters/environment-name"
50764
- },
50765
- {
50766
- "$ref": "#/components/parameters/secret-name"
50767
- }
50768
- ],
50769
- "responses": {
50770
- "204": {
50771
- "description": "Default response"
50772
- }
50773
- },
50774
- "x-github": {
50775
- "githubCloudOnly": false,
50776
- "enabledForGitHubApps": true,
50777
- "category": "actions",
50778
- "subcategory": "secrets"
50779
- },
50780
- "x-octokit": {}
50781
- }
50782
- },
50783
- "/repositories/{repository_id}/environments/{environment_name}/variables": {
50784
- "get": {
50785
- "summary": "List environment variables",
50786
- "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.",
50787
- "tags": [
50788
- "actions"
50789
- ],
50790
- "operationId": "actions/list-environment-variables",
50791
- "externalDocs": {
50792
- "description": "API method documentation",
50793
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#list-environment-variables"
50794
- },
50795
- "parameters": [
50796
- {
50797
- "$ref": "#/components/parameters/repository-id"
50798
- },
50799
- {
50800
- "$ref": "#/components/parameters/environment-name"
50801
- },
50802
- {
50803
- "$ref": "#/components/parameters/variables-per-page"
50804
- },
50805
- {
50806
- "$ref": "#/components/parameters/page"
50807
- }
50808
- ],
50809
- "responses": {
50810
- "200": {
50811
- "description": "Response",
50812
- "content": {
50813
- "application/json": {
50814
- "schema": {
50815
- "type": "object",
50816
- "required": [
50817
- "total_count",
50818
- "variables"
50819
- ],
50820
- "properties": {
50821
- "total_count": {
50822
- "type": "integer"
50823
- },
50824
- "variables": {
50825
- "type": "array",
50826
- "items": {
50827
- "$ref": "#/components/schemas/actions-variable"
50828
- }
50829
- }
50830
- }
50831
- },
50832
- "examples": {
50833
- "default": {
50834
- "$ref": "#/components/examples/actions-variables-paginated"
50835
- }
50836
- }
50837
- }
50838
- },
50839
- "headers": {
50840
- "Link": {
50841
- "$ref": "#/components/headers/link"
50842
- }
50843
- }
50844
- }
50845
- },
50846
- "x-github": {
50847
- "githubCloudOnly": false,
50848
- "enabledForGitHubApps": true,
50849
- "category": "actions",
50850
- "subcategory": "variables"
50851
- },
50852
- "x-octokit": {}
50853
- },
50854
- "post": {
50855
- "summary": "Create an environment variable",
50856
- "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.",
50857
- "tags": [
50858
- "actions"
50859
- ],
50860
- "operationId": "actions/create-environment-variable",
50861
- "externalDocs": {
50862
- "description": "API method documentation",
50863
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#create-an-environment-variable"
50864
- },
50865
- "parameters": [
50866
- {
50867
- "$ref": "#/components/parameters/repository-id"
50868
- },
50869
- {
50870
- "$ref": "#/components/parameters/environment-name"
50871
- }
50872
- ],
50873
- "requestBody": {
50874
- "required": true,
50875
- "content": {
50876
- "application/json": {
50877
- "schema": {
50878
- "type": "object",
50879
- "properties": {
50880
- "name": {
50881
- "type": "string",
50882
- "description": "The name of the variable."
50883
- },
50884
- "value": {
50885
- "type": "string",
50886
- "description": "The value of the variable."
50887
- }
50888
- },
50889
- "required": [
50890
- "name",
50891
- "value"
50892
- ]
50893
- },
50894
- "examples": {
50895
- "default": {
50896
- "value": {
50897
- "name": "USERNAME",
50898
- "value": "octocat"
50899
- }
50900
- }
50901
- }
50902
- }
50903
- }
50904
- },
50905
- "responses": {
50906
- "201": {
50907
- "description": "Response",
50908
- "content": {
50909
- "application/json": {
50910
- "schema": {
50911
- "$ref": "#/components/schemas/empty-object"
50912
- },
50913
- "examples": {
50914
- "default": {
50915
- "value": null
50916
- }
50917
- }
50918
- }
50919
- }
50920
- }
50921
- },
50922
- "x-github": {
50923
- "githubCloudOnly": false,
50924
- "enabledForGitHubApps": true,
50925
- "category": "actions",
50926
- "subcategory": "variables"
50927
- },
50928
- "x-octokit": {}
50929
- }
50930
- },
50931
- "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
50932
- "get": {
50933
- "summary": "Get an environment variable",
50934
- "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.",
50935
- "tags": [
50936
- "actions"
50937
- ],
50938
- "operationId": "actions/get-environment-variable",
50939
- "externalDocs": {
50940
- "description": "API method documentation",
50941
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#get-an-environment-variable"
50942
- },
50943
- "parameters": [
50944
- {
50945
- "$ref": "#/components/parameters/repository-id"
50946
- },
50947
- {
50948
- "$ref": "#/components/parameters/environment-name"
50949
- },
50950
- {
50951
- "$ref": "#/components/parameters/variable-name"
50952
- }
50953
- ],
50954
- "responses": {
50955
- "200": {
50956
- "description": "Response",
50957
- "content": {
50958
- "application/json": {
50959
- "schema": {
50960
- "$ref": "#/components/schemas/actions-variable"
50961
- },
50962
- "examples": {
50963
- "default": {
50964
- "$ref": "#/components/examples/actions-variable"
50965
- }
50966
- }
50967
- }
50968
- }
50969
- }
50970
- },
50971
- "x-github": {
50972
- "githubCloudOnly": false,
50973
- "enabledForGitHubApps": true,
50974
- "category": "actions",
50975
- "subcategory": "variables"
50976
- },
50977
- "x-octokit": {}
50978
- },
50979
- "patch": {
50980
- "summary": "Update an environment variable",
50981
- "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.",
50982
- "tags": [
50983
- "actions"
50984
- ],
50985
- "operationId": "actions/update-environment-variable",
50986
- "externalDocs": {
50987
- "description": "API method documentation",
50988
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#update-an-environment-variable"
50989
- },
50990
- "parameters": [
50991
- {
50992
- "$ref": "#/components/parameters/repository-id"
50993
- },
50994
- {
50995
- "$ref": "#/components/parameters/variable-name"
50996
- },
50997
- {
50998
- "$ref": "#/components/parameters/environment-name"
50999
- }
51000
- ],
51001
- "requestBody": {
51002
- "required": true,
51003
- "content": {
51004
- "application/json": {
51005
- "schema": {
51006
- "type": "object",
51007
- "properties": {
51008
- "name": {
51009
- "type": "string",
51010
- "description": "The name of the variable."
51011
- },
51012
- "value": {
51013
- "type": "string",
51014
- "description": "The value of the variable."
51015
- }
51016
- }
51017
- },
51018
- "examples": {
51019
- "default": {
51020
- "value": {
51021
- "name": "USERNAME",
51022
- "value": "octocat"
51023
- }
51024
- }
51025
- }
51026
- }
51027
- }
51028
- },
51029
- "responses": {
51030
- "204": {
51031
- "description": "Response"
51032
- }
51033
- },
51034
- "x-github": {
51035
- "githubCloudOnly": false,
51036
- "enabledForGitHubApps": true,
51037
- "category": "actions",
51038
- "subcategory": "variables"
51039
- },
51040
- "x-octokit": {}
51041
- },
51042
- "delete": {
51043
- "summary": "Delete an environment variable",
51044
- "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.",
51045
- "tags": [
51046
- "actions"
51047
- ],
51048
- "operationId": "actions/delete-environment-variable",
51049
- "externalDocs": {
51050
- "description": "API method documentation",
51051
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#delete-an-environment-variable"
51052
- },
51053
- "parameters": [
51054
- {
51055
- "$ref": "#/components/parameters/repository-id"
51056
- },
51057
- {
51058
- "$ref": "#/components/parameters/variable-name"
51059
- },
51060
- {
51061
- "$ref": "#/components/parameters/environment-name"
51062
- }
51063
- ],
51064
- "responses": {
51065
- "204": {
51066
- "description": "Response"
51067
- }
51068
- },
51069
- "x-github": {
51070
- "githubCloudOnly": false,
51071
- "enabledForGitHubApps": true,
51072
- "category": "actions",
51073
- "subcategory": "variables"
51074
- },
51075
- "x-octokit": {}
51076
- }
51077
- },
51078
- "/scim/v2/Groups": {
51153
+ "/scim/v2/enterprises/{enterprise}/Groups": {
51079
51154
  "get": {
51080
51155
  "summary": "List provisioned SCIM groups for an enterprise",
51081
51156
  "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.",
@@ -51114,6 +51189,9 @@
51114
51189
  },
51115
51190
  {
51116
51191
  "$ref": "#/components/parameters/count"
51192
+ },
51193
+ {
51194
+ "$ref": "#/components/parameters/enterprise"
51117
51195
  }
51118
51196
  ],
51119
51197
  "responses": {
@@ -51167,6 +51245,11 @@
51167
51245
  "description": "API method documentation",
51168
51246
  "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#provision-a-scim-enterprise-group"
51169
51247
  },
51248
+ "parameters": [
51249
+ {
51250
+ "$ref": "#/components/parameters/enterprise"
51251
+ }
51252
+ ],
51170
51253
  "requestBody": {
51171
51254
  "required": true,
51172
51255
  "content": {
@@ -51232,7 +51315,7 @@
51232
51315
  "x-octokit": {}
51233
51316
  }
51234
51317
  },
51235
- "/scim/v2/Groups/{scim_group_id}": {
51318
+ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": {
51236
51319
  "get": {
51237
51320
  "summary": "Get SCIM provisioning information for an enterprise group",
51238
51321
  "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.",
@@ -51250,6 +51333,9 @@
51250
51333
  },
51251
51334
  {
51252
51335
  "$ref": "#/components/parameters/excluded-attributes"
51336
+ },
51337
+ {
51338
+ "$ref": "#/components/parameters/enterprise"
51253
51339
  }
51254
51340
  ],
51255
51341
  "responses": {
@@ -51309,6 +51395,9 @@
51309
51395
  "parameters": [
51310
51396
  {
51311
51397
  "$ref": "#/components/parameters/scim-group-id"
51398
+ },
51399
+ {
51400
+ "$ref": "#/components/parameters/enterprise"
51312
51401
  }
51313
51402
  ],
51314
51403
  "requestBody": {
@@ -51416,6 +51505,9 @@
51416
51505
  "parameters": [
51417
51506
  {
51418
51507
  "$ref": "#/components/parameters/scim-group-id"
51508
+ },
51509
+ {
51510
+ "$ref": "#/components/parameters/enterprise"
51419
51511
  }
51420
51512
  ],
51421
51513
  "requestBody": {
@@ -51533,6 +51625,9 @@
51533
51625
  "parameters": [
51534
51626
  {
51535
51627
  "$ref": "#/components/parameters/scim-group-id"
51628
+ },
51629
+ {
51630
+ "$ref": "#/components/parameters/enterprise"
51536
51631
  }
51537
51632
  ],
51538
51633
  "responses": {
@@ -51567,7 +51662,7 @@
51567
51662
  "x-octokit": {}
51568
51663
  }
51569
51664
  },
51570
- "/scim/v2/Users": {
51665
+ "/scim/v2/enterprises/{enterprise}/Users": {
51571
51666
  "get": {
51572
51667
  "summary": "List SCIM provisioned identities for an enterprise",
51573
51668
  "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.",
@@ -51602,6 +51697,9 @@
51602
51697
  },
51603
51698
  {
51604
51699
  "$ref": "#/components/parameters/count"
51700
+ },
51701
+ {
51702
+ "$ref": "#/components/parameters/enterprise"
51605
51703
  }
51606
51704
  ],
51607
51705
  "responses": {
@@ -51655,6 +51753,11 @@
51655
51753
  "description": "API method documentation",
51656
51754
  "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#provision-a-scim-enterprise-user"
51657
51755
  },
51756
+ "parameters": [
51757
+ {
51758
+ "$ref": "#/components/parameters/enterprise"
51759
+ }
51760
+ ],
51658
51761
  "requestBody": {
51659
51762
  "required": true,
51660
51763
  "content": {
@@ -51720,7 +51823,7 @@
51720
51823
  "x-octokit": {}
51721
51824
  }
51722
51825
  },
51723
- "/scim/v2/Users/{scim_user_id}": {
51826
+ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": {
51724
51827
  "get": {
51725
51828
  "summary": "Get SCIM provisioning information for an enterprise user",
51726
51829
  "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.",
@@ -51735,6 +51838,9 @@
51735
51838
  "parameters": [
51736
51839
  {
51737
51840
  "$ref": "#/components/parameters/scim-user-id"
51841
+ },
51842
+ {
51843
+ "$ref": "#/components/parameters/enterprise"
51738
51844
  }
51739
51845
  ],
51740
51846
  "responses": {
@@ -51794,6 +51900,9 @@
51794
51900
  "parameters": [
51795
51901
  {
51796
51902
  "$ref": "#/components/parameters/scim-user-id"
51903
+ },
51904
+ {
51905
+ "$ref": "#/components/parameters/enterprise"
51797
51906
  }
51798
51907
  ],
51799
51908
  "requestBody": {
@@ -51871,6 +51980,9 @@
51871
51980
  "parameters": [
51872
51981
  {
51873
51982
  "$ref": "#/components/parameters/scim-user-id"
51983
+ },
51984
+ {
51985
+ "$ref": "#/components/parameters/enterprise"
51874
51986
  }
51875
51987
  ],
51876
51988
  "requestBody": {
@@ -52006,6 +52118,9 @@
52006
52118
  "parameters": [
52007
52119
  {
52008
52120
  "$ref": "#/components/parameters/scim-user-id"
52121
+ },
52122
+ {
52123
+ "$ref": "#/components/parameters/enterprise"
52009
52124
  }
52010
52125
  ],
52011
52126
  "responses": {
@@ -60436,7 +60551,7 @@
60436
60551
  "/users/{username}/hovercard": {
60437
60552
  "get": {
60438
60553
  "summary": "Get contextual information for a user",
60439
- "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.",
60554
+ "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.",
60440
60555
  "tags": [
60441
60556
  "users"
60442
60557
  ],
@@ -80920,8 +81035,7 @@
80920
81035
  },
80921
81036
  "repository-dispatch-sample.collected": {
80922
81037
  "post": {
80923
- "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.9/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.",
80924
- "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.",
81038
+ "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.9/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.",
80925
81039
  "operationId": "repository-dispatch/sample.collected",
80926
81040
  "externalDocs": {
80927
81041
  "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_dispatch"
@@ -85983,7 +86097,8 @@
85983
86097
  },
85984
86098
  "hub_url": {
85985
86099
  "type": "string",
85986
- "format": "uri-template"
86100
+ "format": "uri-template",
86101
+ "deprecated": true
85987
86102
  },
85988
86103
  "issue_search_url": {
85989
86104
  "type": "string",
@@ -86079,7 +86194,6 @@
86079
86194
  "followers_url",
86080
86195
  "following_url",
86081
86196
  "gists_url",
86082
- "hub_url",
86083
86197
  "issue_search_url",
86084
86198
  "issues_url",
86085
86199
  "keys_url",
@@ -98628,7 +98742,9 @@
98628
98742
  "queued",
98629
98743
  "in_progress",
98630
98744
  "completed",
98631
- "waiting"
98745
+ "waiting",
98746
+ "requested",
98747
+ "pending"
98632
98748
  ]
98633
98749
  },
98634
98750
  "conclusion": {
@@ -101033,13 +101149,16 @@
101033
101149
  "nullable": true
101034
101150
  },
101035
101151
  "status": {
101036
- "description": "The phase of the lifecycle that the check is currently in.",
101152
+ "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.",
101037
101153
  "example": "queued",
101038
101154
  "type": "string",
101039
101155
  "enum": [
101040
101156
  "queued",
101041
101157
  "in_progress",
101042
- "completed"
101158
+ "completed",
101159
+ "waiting",
101160
+ "requested",
101161
+ "pending"
101043
101162
  ]
101044
101163
  },
101045
101164
  "conclusion": {
@@ -101317,11 +101436,15 @@
101317
101436
  },
101318
101437
  "status": {
101319
101438
  "type": "string",
101439
+ "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.",
101320
101440
  "example": "completed",
101321
101441
  "enum": [
101322
101442
  "queued",
101323
101443
  "in_progress",
101324
- "completed"
101444
+ "completed",
101445
+ "waiting",
101446
+ "requested",
101447
+ "pending"
101325
101448
  ],
101326
101449
  "nullable": true
101327
101450
  },
@@ -165006,6 +165129,7 @@
165006
165129
  "type": "object",
165007
165130
  "properties": {
165008
165131
  "permission": {
165132
+ "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.",
165009
165133
  "type": "object",
165010
165134
  "properties": {
165011
165135
  "to": {
@@ -165020,6 +165144,18 @@
165020
165144
  "required": [
165021
165145
  "to"
165022
165146
  ]
165147
+ },
165148
+ "role_name": {
165149
+ "description": "The role assigned to the collaborator.",
165150
+ "type": "object",
165151
+ "properties": {
165152
+ "to": {
165153
+ "type": "string"
165154
+ }
165155
+ },
165156
+ "required": [
165157
+ "to"
165158
+ ]
165023
165159
  }
165024
165160
  }
165025
165161
  },
@@ -243410,7 +243546,7 @@
243410
243546
  "type": "string"
243411
243547
  },
243412
243548
  "commits": {
243413
- "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.9/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.",
243549
+ "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.9/rest/commits) to fetch additional commits.",
243414
243550
  "type": "array",
243415
243551
  "items": {
243416
243552
  "title": "Commit",
@@ -249230,9 +249366,7 @@
249230
249366
  "properties": {
249231
249367
  "action": {
249232
249368
  "type": "string",
249233
- "enum": [
249234
- "sample.collected"
249235
- ]
249369
+ "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
249236
249370
  },
249237
249371
  "branch": {
249238
249372
  "type": "string"
@@ -249240,7 +249374,8 @@
249240
249374
  "client_payload": {
249241
249375
  "type": "object",
249242
249376
  "nullable": true,
249243
- "additionalProperties": true
249377
+ "additionalProperties": true,
249378
+ "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
249244
249379
  },
249245
249380
  "enterprise": {
249246
249381
  "$ref": "#/components/schemas/enterprise-webhooks"
@@ -285687,6 +285822,20 @@
285687
285822
  "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b"
285688
285823
  }
285689
285824
  },
285825
+ {
285826
+ "type": "wiki_commit",
285827
+ "details": {
285828
+ "path": "/example/Home.md",
285829
+ "start_line": 1,
285830
+ "end_line": 1,
285831
+ "start_column": 1,
285832
+ "end_column": 64,
285833
+ "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b",
285834
+ "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5",
285835
+ "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5",
285836
+ "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
285837
+ }
285838
+ },
285690
285839
  {
285691
285840
  "type": "issue_title",
285692
285841
  "details": {
@@ -292112,7 +292261,7 @@
292112
292261
  },
292113
292262
  "workflow-run-status": {
292114
292263
  "name": "status",
292115
- "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`.",
292264
+ "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`.",
292116
292265
  "in": "query",
292117
292266
  "required": false,
292118
292267
  "schema": {
@@ -292357,6 +292506,17 @@
292357
292506
  "type": "integer"
292358
292507
  }
292359
292508
  },
292509
+ "git-ref-only": {
292510
+ "name": "ref",
292511
+ "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.",
292512
+ "in": "path",
292513
+ "required": true,
292514
+ "example": "heads/feature-a",
292515
+ "schema": {
292516
+ "type": "string"
292517
+ },
292518
+ "x-multi-segment": true
292519
+ },
292360
292520
  "invitation-id": {
292361
292521
  "name": "invitation_id",
292362
292522
  "description": "The unique identifier of the invitation.",
@@ -292929,6 +293089,16 @@
292929
293089
  }
292930
293090
  }
292931
293091
  },
293092
+ "unacceptable": {
293093
+ "description": "Unacceptable",
293094
+ "content": {
293095
+ "application/json": {
293096
+ "schema": {
293097
+ "$ref": "#/components/schemas/basic-error"
293098
+ }
293099
+ }
293100
+ }
293101
+ },
292932
293102
  "no_content": {
292933
293103
  "description": "A header with no content is returned."
292934
293104
  },