@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": {
@@ -261,21 +261,7 @@
261
261
  "in": "query",
262
262
  "description": "If specified, only advisories for these ecosystems will be returned.",
263
263
  "schema": {
264
- "type": "string",
265
- "enum": [
266
- "actions",
267
- "composer",
268
- "erlang",
269
- "go",
270
- "maven",
271
- "npm",
272
- "nuget",
273
- "other",
274
- "pip",
275
- "pub",
276
- "rubygems",
277
- "rust"
278
- ]
264
+ "$ref": "#/components/schemas/security-advisory-ecosystems"
279
265
  }
280
266
  },
281
267
  {
@@ -3039,7 +3025,7 @@
3039
3025
  "/feeds": {
3040
3026
  "get": {
3041
3027
  "summary": "Get feeds",
3042
- "description": "GitHub 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 global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/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.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
3028
+ "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 global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/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.\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/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/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
3043
3029
  "tags": [
3044
3030
  "activity"
3045
3031
  ],
@@ -5967,7 +5953,7 @@
5967
5953
  "/organizations": {
5968
5954
  "get": {
5969
5955
  "summary": "List organizations",
5970
- "description": "Lists all organizations, in the order that they were created on GitHub.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
5956
+ "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/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
5971
5957
  "tags": [
5972
5958
  "orgs"
5973
5959
  ],
@@ -9912,6 +9898,9 @@
9912
9898
  "404": {
9913
9899
  "$ref": "#/components/responses/not_found"
9914
9900
  },
9901
+ "422": {
9902
+ "description": "There is a problem with your account's associated payment method."
9903
+ },
9915
9904
  "500": {
9916
9905
  "$ref": "#/components/responses/internal_error"
9917
9906
  }
@@ -11196,7 +11185,7 @@
11196
11185
  "/orgs/{org}/hooks": {
11197
11186
  "get": {
11198
11187
  "summary": "List organization webhooks",
11199
- "description": "",
11188
+ "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.",
11200
11189
  "tags": [
11201
11190
  "orgs"
11202
11191
  ],
@@ -11254,7 +11243,7 @@
11254
11243
  },
11255
11244
  "post": {
11256
11245
  "summary": "Create an organization webhook",
11257
- "description": "Here's how you can create a hook that posts payloads in JSON format:",
11246
+ "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.",
11258
11247
  "tags": [
11259
11248
  "orgs"
11260
11249
  ],
@@ -11391,7 +11380,7 @@
11391
11380
  "/orgs/{org}/hooks/{hook_id}": {
11392
11381
  "get": {
11393
11382
  "summary": "Get an organization webhook",
11394
- "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).\"",
11383
+ "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.",
11395
11384
  "tags": [
11396
11385
  "orgs"
11397
11386
  ],
@@ -11438,7 +11427,7 @@
11438
11427
  },
11439
11428
  "patch": {
11440
11429
  "summary": "Update an organization webhook",
11441
- "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).\"",
11430
+ "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.",
11442
11431
  "tags": [
11443
11432
  "orgs"
11444
11433
  ],
@@ -11550,7 +11539,7 @@
11550
11539
  },
11551
11540
  "delete": {
11552
11541
  "summary": "Delete an organization webhook",
11553
- "description": "",
11542
+ "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.",
11554
11543
  "tags": [
11555
11544
  "orgs"
11556
11545
  ],
@@ -11587,7 +11576,7 @@
11587
11576
  "/orgs/{org}/hooks/{hook_id}/config": {
11588
11577
  "get": {
11589
11578
  "summary": "Get a webhook configuration for an organization",
11590
- "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.",
11579
+ "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.",
11591
11580
  "tags": [
11592
11581
  "orgs"
11593
11582
  ],
@@ -11631,7 +11620,7 @@
11631
11620
  },
11632
11621
  "patch": {
11633
11622
  "summary": "Update a webhook configuration for an organization",
11634
- "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.",
11623
+ "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.",
11635
11624
  "tags": [
11636
11625
  "orgs"
11637
11626
  ],
@@ -11712,7 +11701,7 @@
11712
11701
  "/orgs/{org}/hooks/{hook_id}/deliveries": {
11713
11702
  "get": {
11714
11703
  "summary": "List deliveries for an organization webhook",
11715
- "description": "Returns a list of webhook deliveries for a webhook configured in an organization.",
11704
+ "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.",
11716
11705
  "tags": [
11717
11706
  "orgs"
11718
11707
  ],
@@ -11781,7 +11770,7 @@
11781
11770
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
11782
11771
  "get": {
11783
11772
  "summary": "Get a webhook delivery for an organization webhook",
11784
- "description": "Returns a delivery for a webhook configured in an organization.",
11773
+ "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.",
11785
11774
  "tags": [
11786
11775
  "orgs"
11787
11776
  ],
@@ -11836,7 +11825,7 @@
11836
11825
  "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
11837
11826
  "post": {
11838
11827
  "summary": "Redeliver a delivery for an organization webhook",
11839
- "description": "Redeliver a delivery for a webhook configured in an organization.",
11828
+ "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.",
11840
11829
  "tags": [
11841
11830
  "orgs"
11842
11831
  ],
@@ -11879,7 +11868,7 @@
11879
11868
  "/orgs/{org}/hooks/{hook_id}/pings": {
11880
11869
  "post": {
11881
11870
  "summary": "Ping an organization webhook",
11882
- "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.",
11871
+ "description": "This will trigger a [ping event](https://docs.github.com/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.",
11883
11872
  "tags": [
11884
11873
  "orgs"
11885
11874
  ],
@@ -24201,7 +24190,7 @@
24201
24190
  "/repos/{owner}/{repo}/actions/runs": {
24202
24191
  "get": {
24203
24192
  "summary": "List workflow runs for a repository",
24204
- "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/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.",
24193
+ "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/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`.",
24205
24194
  "tags": [
24206
24195
  "actions"
24207
24196
  ],
@@ -30240,11 +30229,14 @@
30240
30229
  },
30241
30230
  "status": {
30242
30231
  "type": "string",
30243
- "description": "The current status.",
30232
+ "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
30244
30233
  "enum": [
30245
30234
  "queued",
30246
30235
  "in_progress",
30247
- "completed"
30236
+ "completed",
30237
+ "waiting",
30238
+ "requested",
30239
+ "pending"
30248
30240
  ]
30249
30241
  },
30250
30242
  "conclusion": {
@@ -33915,6 +33907,9 @@
33915
33907
  }
33916
33908
  }
33917
33909
  },
33910
+ "409": {
33911
+ "$ref": "#/components/responses/conflict"
33912
+ },
33918
33913
  "422": {
33919
33914
  "$ref": "#/components/responses/validation_failed"
33920
33915
  }
@@ -34146,6 +34141,9 @@
34146
34141
  "$ref": "#/components/headers/link"
34147
34142
  }
34148
34143
  }
34144
+ },
34145
+ "409": {
34146
+ "$ref": "#/components/responses/conflict"
34149
34147
  }
34150
34148
  },
34151
34149
  "x-github": {
@@ -34205,6 +34203,9 @@
34205
34203
  "404": {
34206
34204
  "$ref": "#/components/responses/not_found"
34207
34205
  },
34206
+ "409": {
34207
+ "$ref": "#/components/responses/conflict"
34208
+ },
34208
34209
  "422": {
34209
34210
  "$ref": "#/components/responses/validation_failed"
34210
34211
  },
@@ -34588,7 +34589,7 @@
34588
34589
  "/repos/{owner}/{repo}/compare/{basehead}": {
34589
34590
  "get": {
34590
34591
  "summary": "Compare two commits",
34591
- "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/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/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/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. |",
34592
+ "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/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/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/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. |",
34592
34593
  "tags": [
34593
34594
  "repos"
34594
34595
  ],
@@ -36608,6 +36609,9 @@
36608
36609
  "204": {
36609
36610
  "description": "Response"
36610
36611
  },
36612
+ "404": {
36613
+ "$ref": "#/components/responses/not_found"
36614
+ },
36611
36615
  "422": {
36612
36616
  "$ref": "#/components/responses/validation_failed"
36613
36617
  }
@@ -37529,6 +37533,616 @@
37529
37533
  "x-octokit": {}
37530
37534
  }
37531
37535
  },
37536
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
37537
+ "get": {
37538
+ "summary": "List environment secrets",
37539
+ "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.",
37540
+ "tags": [
37541
+ "actions"
37542
+ ],
37543
+ "operationId": "actions/list-environment-secrets",
37544
+ "externalDocs": {
37545
+ "description": "API method documentation",
37546
+ "url": "https://docs.github.com/rest/actions/secrets#list-environment-secrets"
37547
+ },
37548
+ "parameters": [
37549
+ {
37550
+ "$ref": "#/components/parameters/owner"
37551
+ },
37552
+ {
37553
+ "$ref": "#/components/parameters/repo"
37554
+ },
37555
+ {
37556
+ "$ref": "#/components/parameters/environment-name"
37557
+ },
37558
+ {
37559
+ "$ref": "#/components/parameters/per-page"
37560
+ },
37561
+ {
37562
+ "$ref": "#/components/parameters/page"
37563
+ }
37564
+ ],
37565
+ "responses": {
37566
+ "200": {
37567
+ "description": "Response",
37568
+ "content": {
37569
+ "application/json": {
37570
+ "schema": {
37571
+ "type": "object",
37572
+ "required": [
37573
+ "total_count",
37574
+ "secrets"
37575
+ ],
37576
+ "properties": {
37577
+ "total_count": {
37578
+ "type": "integer"
37579
+ },
37580
+ "secrets": {
37581
+ "type": "array",
37582
+ "items": {
37583
+ "$ref": "#/components/schemas/actions-secret"
37584
+ }
37585
+ }
37586
+ }
37587
+ },
37588
+ "examples": {
37589
+ "default": {
37590
+ "$ref": "#/components/examples/actions-secret-paginated"
37591
+ }
37592
+ }
37593
+ }
37594
+ },
37595
+ "headers": {
37596
+ "Link": {
37597
+ "$ref": "#/components/headers/link"
37598
+ }
37599
+ }
37600
+ }
37601
+ },
37602
+ "x-github": {
37603
+ "githubCloudOnly": false,
37604
+ "enabledForGitHubApps": true,
37605
+ "category": "actions",
37606
+ "subcategory": "secrets"
37607
+ },
37608
+ "x-octokit": {}
37609
+ }
37610
+ },
37611
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
37612
+ "get": {
37613
+ "summary": "Get an environment public key",
37614
+ "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.",
37615
+ "tags": [
37616
+ "actions"
37617
+ ],
37618
+ "operationId": "actions/get-environment-public-key",
37619
+ "externalDocs": {
37620
+ "description": "API method documentation",
37621
+ "url": "https://docs.github.com/rest/actions/secrets#get-an-environment-public-key"
37622
+ },
37623
+ "parameters": [
37624
+ {
37625
+ "$ref": "#/components/parameters/owner"
37626
+ },
37627
+ {
37628
+ "$ref": "#/components/parameters/repo"
37629
+ },
37630
+ {
37631
+ "$ref": "#/components/parameters/environment-name"
37632
+ }
37633
+ ],
37634
+ "responses": {
37635
+ "200": {
37636
+ "description": "Response",
37637
+ "content": {
37638
+ "application/json": {
37639
+ "schema": {
37640
+ "$ref": "#/components/schemas/actions-public-key"
37641
+ },
37642
+ "examples": {
37643
+ "default": {
37644
+ "$ref": "#/components/examples/actions-public-key"
37645
+ }
37646
+ }
37647
+ }
37648
+ }
37649
+ }
37650
+ },
37651
+ "x-github": {
37652
+ "githubCloudOnly": false,
37653
+ "enabledForGitHubApps": true,
37654
+ "category": "actions",
37655
+ "subcategory": "secrets"
37656
+ },
37657
+ "x-octokit": {}
37658
+ }
37659
+ },
37660
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
37661
+ "get": {
37662
+ "summary": "Get an environment secret",
37663
+ "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.",
37664
+ "tags": [
37665
+ "actions"
37666
+ ],
37667
+ "operationId": "actions/get-environment-secret",
37668
+ "externalDocs": {
37669
+ "description": "API method documentation",
37670
+ "url": "https://docs.github.com/rest/actions/secrets#get-an-environment-secret"
37671
+ },
37672
+ "parameters": [
37673
+ {
37674
+ "$ref": "#/components/parameters/owner"
37675
+ },
37676
+ {
37677
+ "$ref": "#/components/parameters/repo"
37678
+ },
37679
+ {
37680
+ "$ref": "#/components/parameters/environment-name"
37681
+ },
37682
+ {
37683
+ "$ref": "#/components/parameters/secret-name"
37684
+ }
37685
+ ],
37686
+ "responses": {
37687
+ "200": {
37688
+ "description": "Response",
37689
+ "content": {
37690
+ "application/json": {
37691
+ "schema": {
37692
+ "$ref": "#/components/schemas/actions-secret"
37693
+ },
37694
+ "examples": {
37695
+ "default": {
37696
+ "$ref": "#/components/examples/actions-secret"
37697
+ }
37698
+ }
37699
+ }
37700
+ }
37701
+ }
37702
+ },
37703
+ "x-github": {
37704
+ "githubCloudOnly": false,
37705
+ "enabledForGitHubApps": true,
37706
+ "category": "actions",
37707
+ "subcategory": "secrets"
37708
+ },
37709
+ "x-octokit": {}
37710
+ },
37711
+ "put": {
37712
+ "summary": "Create or update an environment secret",
37713
+ "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/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.",
37714
+ "tags": [
37715
+ "actions"
37716
+ ],
37717
+ "operationId": "actions/create-or-update-environment-secret",
37718
+ "externalDocs": {
37719
+ "description": "API method documentation",
37720
+ "url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret"
37721
+ },
37722
+ "parameters": [
37723
+ {
37724
+ "$ref": "#/components/parameters/owner"
37725
+ },
37726
+ {
37727
+ "$ref": "#/components/parameters/repo"
37728
+ },
37729
+ {
37730
+ "$ref": "#/components/parameters/environment-name"
37731
+ },
37732
+ {
37733
+ "$ref": "#/components/parameters/secret-name"
37734
+ }
37735
+ ],
37736
+ "requestBody": {
37737
+ "required": true,
37738
+ "content": {
37739
+ "application/json": {
37740
+ "schema": {
37741
+ "type": "object",
37742
+ "properties": {
37743
+ "encrypted_value": {
37744
+ "type": "string",
37745
+ "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/rest/actions/secrets#get-an-environment-public-key) endpoint.",
37746
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
37747
+ },
37748
+ "key_id": {
37749
+ "type": "string",
37750
+ "description": "ID of the key you used to encrypt the secret."
37751
+ }
37752
+ },
37753
+ "required": [
37754
+ "encrypted_value",
37755
+ "key_id"
37756
+ ]
37757
+ },
37758
+ "examples": {
37759
+ "default": {
37760
+ "value": {
37761
+ "encrypted_value": "c2VjcmV0",
37762
+ "key_id": "012345678912345678"
37763
+ }
37764
+ }
37765
+ }
37766
+ }
37767
+ }
37768
+ },
37769
+ "responses": {
37770
+ "201": {
37771
+ "description": "Response when creating a secret",
37772
+ "content": {
37773
+ "application/json": {
37774
+ "schema": {
37775
+ "$ref": "#/components/schemas/empty-object"
37776
+ },
37777
+ "examples": {
37778
+ "default": {
37779
+ "value": null
37780
+ }
37781
+ }
37782
+ }
37783
+ }
37784
+ },
37785
+ "204": {
37786
+ "description": "Response when updating a secret"
37787
+ }
37788
+ },
37789
+ "x-github": {
37790
+ "githubCloudOnly": false,
37791
+ "enabledForGitHubApps": true,
37792
+ "category": "actions",
37793
+ "subcategory": "secrets"
37794
+ },
37795
+ "x-octokit": {}
37796
+ },
37797
+ "delete": {
37798
+ "summary": "Delete an environment secret",
37799
+ "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.",
37800
+ "tags": [
37801
+ "actions"
37802
+ ],
37803
+ "operationId": "actions/delete-environment-secret",
37804
+ "externalDocs": {
37805
+ "description": "API method documentation",
37806
+ "url": "https://docs.github.com/rest/actions/secrets#delete-an-environment-secret"
37807
+ },
37808
+ "parameters": [
37809
+ {
37810
+ "$ref": "#/components/parameters/owner"
37811
+ },
37812
+ {
37813
+ "$ref": "#/components/parameters/repo"
37814
+ },
37815
+ {
37816
+ "$ref": "#/components/parameters/environment-name"
37817
+ },
37818
+ {
37819
+ "$ref": "#/components/parameters/secret-name"
37820
+ }
37821
+ ],
37822
+ "responses": {
37823
+ "204": {
37824
+ "description": "Default response"
37825
+ }
37826
+ },
37827
+ "x-github": {
37828
+ "githubCloudOnly": false,
37829
+ "enabledForGitHubApps": true,
37830
+ "category": "actions",
37831
+ "subcategory": "secrets"
37832
+ },
37833
+ "x-octokit": {}
37834
+ }
37835
+ },
37836
+ "/repos/{owner}/{repo}/environments/{environment_name}/variables": {
37837
+ "get": {
37838
+ "summary": "List environment variables",
37839
+ "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.",
37840
+ "tags": [
37841
+ "actions"
37842
+ ],
37843
+ "operationId": "actions/list-environment-variables",
37844
+ "externalDocs": {
37845
+ "description": "API method documentation",
37846
+ "url": "https://docs.github.com/rest/actions/variables#list-environment-variables"
37847
+ },
37848
+ "parameters": [
37849
+ {
37850
+ "$ref": "#/components/parameters/owner"
37851
+ },
37852
+ {
37853
+ "$ref": "#/components/parameters/repo"
37854
+ },
37855
+ {
37856
+ "$ref": "#/components/parameters/environment-name"
37857
+ },
37858
+ {
37859
+ "$ref": "#/components/parameters/variables-per-page"
37860
+ },
37861
+ {
37862
+ "$ref": "#/components/parameters/page"
37863
+ }
37864
+ ],
37865
+ "responses": {
37866
+ "200": {
37867
+ "description": "Response",
37868
+ "content": {
37869
+ "application/json": {
37870
+ "schema": {
37871
+ "type": "object",
37872
+ "required": [
37873
+ "total_count",
37874
+ "variables"
37875
+ ],
37876
+ "properties": {
37877
+ "total_count": {
37878
+ "type": "integer"
37879
+ },
37880
+ "variables": {
37881
+ "type": "array",
37882
+ "items": {
37883
+ "$ref": "#/components/schemas/actions-variable"
37884
+ }
37885
+ }
37886
+ }
37887
+ },
37888
+ "examples": {
37889
+ "default": {
37890
+ "$ref": "#/components/examples/actions-variables-paginated"
37891
+ }
37892
+ }
37893
+ }
37894
+ },
37895
+ "headers": {
37896
+ "Link": {
37897
+ "$ref": "#/components/headers/link"
37898
+ }
37899
+ }
37900
+ }
37901
+ },
37902
+ "x-github": {
37903
+ "githubCloudOnly": false,
37904
+ "enabledForGitHubApps": true,
37905
+ "category": "actions",
37906
+ "subcategory": "variables"
37907
+ },
37908
+ "x-octokit": {}
37909
+ },
37910
+ "post": {
37911
+ "summary": "Create an environment variable",
37912
+ "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.",
37913
+ "tags": [
37914
+ "actions"
37915
+ ],
37916
+ "operationId": "actions/create-environment-variable",
37917
+ "externalDocs": {
37918
+ "description": "API method documentation",
37919
+ "url": "https://docs.github.com/rest/actions/variables#create-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/environment-name"
37930
+ }
37931
+ ],
37932
+ "requestBody": {
37933
+ "required": true,
37934
+ "content": {
37935
+ "application/json": {
37936
+ "schema": {
37937
+ "type": "object",
37938
+ "properties": {
37939
+ "name": {
37940
+ "type": "string",
37941
+ "description": "The name of the variable."
37942
+ },
37943
+ "value": {
37944
+ "type": "string",
37945
+ "description": "The value of the variable."
37946
+ }
37947
+ },
37948
+ "required": [
37949
+ "name",
37950
+ "value"
37951
+ ]
37952
+ },
37953
+ "examples": {
37954
+ "default": {
37955
+ "value": {
37956
+ "name": "USERNAME",
37957
+ "value": "octocat"
37958
+ }
37959
+ }
37960
+ }
37961
+ }
37962
+ }
37963
+ },
37964
+ "responses": {
37965
+ "201": {
37966
+ "description": "Response",
37967
+ "content": {
37968
+ "application/json": {
37969
+ "schema": {
37970
+ "$ref": "#/components/schemas/empty-object"
37971
+ },
37972
+ "examples": {
37973
+ "default": {
37974
+ "value": null
37975
+ }
37976
+ }
37977
+ }
37978
+ }
37979
+ }
37980
+ },
37981
+ "x-github": {
37982
+ "githubCloudOnly": false,
37983
+ "enabledForGitHubApps": true,
37984
+ "category": "actions",
37985
+ "subcategory": "variables"
37986
+ },
37987
+ "x-octokit": {}
37988
+ }
37989
+ },
37990
+ "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
37991
+ "get": {
37992
+ "summary": "Get an environment variable",
37993
+ "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.",
37994
+ "tags": [
37995
+ "actions"
37996
+ ],
37997
+ "operationId": "actions/get-environment-variable",
37998
+ "externalDocs": {
37999
+ "description": "API method documentation",
38000
+ "url": "https://docs.github.com/rest/actions/variables#get-an-environment-variable"
38001
+ },
38002
+ "parameters": [
38003
+ {
38004
+ "$ref": "#/components/parameters/owner"
38005
+ },
38006
+ {
38007
+ "$ref": "#/components/parameters/repo"
38008
+ },
38009
+ {
38010
+ "$ref": "#/components/parameters/environment-name"
38011
+ },
38012
+ {
38013
+ "$ref": "#/components/parameters/variable-name"
38014
+ }
38015
+ ],
38016
+ "responses": {
38017
+ "200": {
38018
+ "description": "Response",
38019
+ "content": {
38020
+ "application/json": {
38021
+ "schema": {
38022
+ "$ref": "#/components/schemas/actions-variable"
38023
+ },
38024
+ "examples": {
38025
+ "default": {
38026
+ "$ref": "#/components/examples/actions-variable"
38027
+ }
38028
+ }
38029
+ }
38030
+ }
38031
+ }
38032
+ },
38033
+ "x-github": {
38034
+ "githubCloudOnly": false,
38035
+ "enabledForGitHubApps": true,
38036
+ "category": "actions",
38037
+ "subcategory": "variables"
38038
+ },
38039
+ "x-octokit": {}
38040
+ },
38041
+ "patch": {
38042
+ "summary": "Update an environment variable",
38043
+ "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.",
38044
+ "tags": [
38045
+ "actions"
38046
+ ],
38047
+ "operationId": "actions/update-environment-variable",
38048
+ "externalDocs": {
38049
+ "description": "API method documentation",
38050
+ "url": "https://docs.github.com/rest/actions/variables#update-an-environment-variable"
38051
+ },
38052
+ "parameters": [
38053
+ {
38054
+ "$ref": "#/components/parameters/owner"
38055
+ },
38056
+ {
38057
+ "$ref": "#/components/parameters/repo"
38058
+ },
38059
+ {
38060
+ "$ref": "#/components/parameters/variable-name"
38061
+ },
38062
+ {
38063
+ "$ref": "#/components/parameters/environment-name"
38064
+ }
38065
+ ],
38066
+ "requestBody": {
38067
+ "required": true,
38068
+ "content": {
38069
+ "application/json": {
38070
+ "schema": {
38071
+ "type": "object",
38072
+ "properties": {
38073
+ "name": {
38074
+ "type": "string",
38075
+ "description": "The name of the variable."
38076
+ },
38077
+ "value": {
38078
+ "type": "string",
38079
+ "description": "The value of the variable."
38080
+ }
38081
+ }
38082
+ },
38083
+ "examples": {
38084
+ "default": {
38085
+ "value": {
38086
+ "name": "USERNAME",
38087
+ "value": "octocat"
38088
+ }
38089
+ }
38090
+ }
38091
+ }
38092
+ }
38093
+ },
38094
+ "responses": {
38095
+ "204": {
38096
+ "description": "Response"
38097
+ }
38098
+ },
38099
+ "x-github": {
38100
+ "githubCloudOnly": false,
38101
+ "enabledForGitHubApps": true,
38102
+ "category": "actions",
38103
+ "subcategory": "variables"
38104
+ },
38105
+ "x-octokit": {}
38106
+ },
38107
+ "delete": {
38108
+ "summary": "Delete an environment variable",
38109
+ "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.",
38110
+ "tags": [
38111
+ "actions"
38112
+ ],
38113
+ "operationId": "actions/delete-environment-variable",
38114
+ "externalDocs": {
38115
+ "description": "API method documentation",
38116
+ "url": "https://docs.github.com/rest/actions/variables#delete-an-environment-variable"
38117
+ },
38118
+ "parameters": [
38119
+ {
38120
+ "$ref": "#/components/parameters/owner"
38121
+ },
38122
+ {
38123
+ "$ref": "#/components/parameters/repo"
38124
+ },
38125
+ {
38126
+ "$ref": "#/components/parameters/variable-name"
38127
+ },
38128
+ {
38129
+ "$ref": "#/components/parameters/environment-name"
38130
+ }
38131
+ ],
38132
+ "responses": {
38133
+ "204": {
38134
+ "description": "Response"
38135
+ }
38136
+ },
38137
+ "x-github": {
38138
+ "githubCloudOnly": false,
38139
+ "enabledForGitHubApps": true,
38140
+ "category": "actions",
38141
+ "subcategory": "variables"
38142
+ },
38143
+ "x-octokit": {}
38144
+ }
38145
+ },
37532
38146
  "/repos/{owner}/{repo}/events": {
37533
38147
  "get": {
37534
38148
  "summary": "List repository events",
@@ -37901,6 +38515,9 @@
37901
38515
  "404": {
37902
38516
  "$ref": "#/components/responses/not_found"
37903
38517
  },
38518
+ "409": {
38519
+ "$ref": "#/components/responses/conflict"
38520
+ },
37904
38521
  "422": {
37905
38522
  "$ref": "#/components/responses/validation_failed"
37906
38523
  }
@@ -38055,6 +38672,9 @@
38055
38672
  "404": {
38056
38673
  "$ref": "#/components/responses/not_found"
38057
38674
  },
38675
+ "409": {
38676
+ "$ref": "#/components/responses/conflict"
38677
+ },
38058
38678
  "422": {
38059
38679
  "$ref": "#/components/responses/validation_failed"
38060
38680
  }
@@ -38109,6 +38729,9 @@
38109
38729
  },
38110
38730
  "404": {
38111
38731
  "$ref": "#/components/responses/not_found"
38732
+ },
38733
+ "409": {
38734
+ "$ref": "#/components/responses/conflict"
38112
38735
  }
38113
38736
  },
38114
38737
  "x-github": {
@@ -38140,7 +38763,7 @@
38140
38763
  "$ref": "#/components/parameters/repo"
38141
38764
  },
38142
38765
  {
38143
- "$ref": "#/components/parameters/commit-ref"
38766
+ "$ref": "#/components/parameters/git-ref-only"
38144
38767
  }
38145
38768
  ],
38146
38769
  "responses": {
@@ -38166,6 +38789,9 @@
38166
38789
  "$ref": "#/components/headers/link"
38167
38790
  }
38168
38791
  }
38792
+ },
38793
+ "409": {
38794
+ "$ref": "#/components/responses/conflict"
38169
38795
  }
38170
38796
  },
38171
38797
  "x-github": {
@@ -38197,7 +38823,7 @@
38197
38823
  "$ref": "#/components/parameters/repo"
38198
38824
  },
38199
38825
  {
38200
- "$ref": "#/components/parameters/commit-ref"
38826
+ "$ref": "#/components/parameters/git-ref-only"
38201
38827
  }
38202
38828
  ],
38203
38829
  "responses": {
@@ -38218,6 +38844,9 @@
38218
38844
  },
38219
38845
  "404": {
38220
38846
  "$ref": "#/components/responses/not_found"
38847
+ },
38848
+ "409": {
38849
+ "$ref": "#/components/responses/conflict"
38221
38850
  }
38222
38851
  },
38223
38852
  "x-github": {
@@ -38305,6 +38934,9 @@
38305
38934
  }
38306
38935
  }
38307
38936
  },
38937
+ "409": {
38938
+ "$ref": "#/components/responses/conflict"
38939
+ },
38308
38940
  "422": {
38309
38941
  "$ref": "#/components/responses/validation_failed"
38310
38942
  }
@@ -38321,7 +38953,7 @@
38321
38953
  "/repos/{owner}/{repo}/git/refs/{ref}": {
38322
38954
  "patch": {
38323
38955
  "summary": "Update a reference",
38324
- "description": "",
38956
+ "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.",
38325
38957
  "tags": [
38326
38958
  "git"
38327
38959
  ],
@@ -38338,15 +38970,7 @@
38338
38970
  "$ref": "#/components/parameters/repo"
38339
38971
  },
38340
38972
  {
38341
- "name": "ref",
38342
- "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.",
38343
- "in": "path",
38344
- "required": true,
38345
- "example": "heads/featureA",
38346
- "schema": {
38347
- "type": "string"
38348
- },
38349
- "x-multi-segment": true
38973
+ "$ref": "#/components/parameters/git-ref-only"
38350
38974
  }
38351
38975
  ],
38352
38976
  "requestBody": {
@@ -38397,6 +39021,9 @@
38397
39021
  }
38398
39022
  }
38399
39023
  },
39024
+ "409": {
39025
+ "$ref": "#/components/responses/conflict"
39026
+ },
38400
39027
  "422": {
38401
39028
  "$ref": "#/components/responses/validation_failed"
38402
39029
  }
@@ -38411,7 +39038,7 @@
38411
39038
  },
38412
39039
  "delete": {
38413
39040
  "summary": "Delete a reference",
38414
- "description": "",
39041
+ "description": "Deletes the provided reference.",
38415
39042
  "tags": [
38416
39043
  "git"
38417
39044
  ],
@@ -38428,13 +39055,16 @@
38428
39055
  "$ref": "#/components/parameters/repo"
38429
39056
  },
38430
39057
  {
38431
- "$ref": "#/components/parameters/commit-ref"
39058
+ "$ref": "#/components/parameters/git-ref-only"
38432
39059
  }
38433
39060
  ],
38434
39061
  "responses": {
38435
39062
  "204": {
38436
39063
  "description": "Response"
38437
39064
  },
39065
+ "409": {
39066
+ "$ref": "#/components/responses/conflict"
39067
+ },
38438
39068
  "422": {
38439
39069
  "$ref": "#/components/responses/validation_failed"
38440
39070
  }
@@ -38569,6 +39199,9 @@
38569
39199
  }
38570
39200
  }
38571
39201
  },
39202
+ "409": {
39203
+ "$ref": "#/components/responses/conflict"
39204
+ },
38572
39205
  "422": {
38573
39206
  "$ref": "#/components/responses/validation_failed"
38574
39207
  }
@@ -38628,6 +39261,9 @@
38628
39261
  },
38629
39262
  "404": {
38630
39263
  "$ref": "#/components/responses/not_found"
39264
+ },
39265
+ "409": {
39266
+ "$ref": "#/components/responses/conflict"
38631
39267
  }
38632
39268
  },
38633
39269
  "x-github": {
@@ -38765,6 +39401,9 @@
38765
39401
  "404": {
38766
39402
  "$ref": "#/components/responses/not_found"
38767
39403
  },
39404
+ "409": {
39405
+ "$ref": "#/components/responses/conflict"
39406
+ },
38768
39407
  "422": {
38769
39408
  "$ref": "#/components/responses/validation_failed"
38770
39409
  }
@@ -38839,6 +39478,9 @@
38839
39478
  "404": {
38840
39479
  "$ref": "#/components/responses/not_found"
38841
39480
  },
39481
+ "409": {
39482
+ "$ref": "#/components/responses/conflict"
39483
+ },
38842
39484
  "422": {
38843
39485
  "$ref": "#/components/responses/validation_failed"
38844
39486
  }
@@ -43706,6 +44348,9 @@
43706
44348
  },
43707
44349
  {
43708
44350
  "$ref": "#/components/parameters/repo"
44351
+ },
44352
+ {
44353
+ "$ref": "#/components/parameters/git-ref"
43709
44354
  }
43710
44355
  ],
43711
44356
  "responses": {
@@ -45342,6 +45987,64 @@
45342
45987
  }
45343
45988
  },
45344
45989
  "/repos/{owner}/{repo}/private-vulnerability-reporting": {
45990
+ "get": {
45991
+ "summary": "Check if private vulnerability reporting is enabled for a repository",
45992
+ "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".",
45993
+ "tags": [
45994
+ "repos"
45995
+ ],
45996
+ "operationId": "repos/check-private-vulnerability-reporting",
45997
+ "externalDocs": {
45998
+ "description": "API method documentation",
45999
+ "url": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository"
46000
+ },
46001
+ "parameters": [
46002
+ {
46003
+ "$ref": "#/components/parameters/owner"
46004
+ },
46005
+ {
46006
+ "$ref": "#/components/parameters/repo"
46007
+ }
46008
+ ],
46009
+ "responses": {
46010
+ "200": {
46011
+ "description": "Private vulnerability reporting status",
46012
+ "content": {
46013
+ "application/json": {
46014
+ "schema": {
46015
+ "type": "object",
46016
+ "properties": {
46017
+ "enabled": {
46018
+ "type": "boolean",
46019
+ "description": "Whether or not private vulnerability reporting is enabled for the repository."
46020
+ }
46021
+ },
46022
+ "required": [
46023
+ "enabled"
46024
+ ]
46025
+ },
46026
+ "examples": {
46027
+ "default": {
46028
+ "value": {
46029
+ "enabled": true
46030
+ }
46031
+ }
46032
+ }
46033
+ }
46034
+ }
46035
+ },
46036
+ "422": {
46037
+ "$ref": "#/components/responses/bad_request"
46038
+ }
46039
+ },
46040
+ "x-github": {
46041
+ "githubCloudOnly": false,
46042
+ "enabledForGitHubApps": true,
46043
+ "category": "repos",
46044
+ "subcategory": "repos"
46045
+ },
46046
+ "x-octokit": {}
46047
+ },
45345
46048
  "put": {
45346
46049
  "summary": "Enable private vulnerability reporting for a repository",
45347
46050
  "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"",
@@ -46488,6 +47191,9 @@
46488
47191
  "404": {
46489
47192
  "$ref": "#/components/responses/not_found"
46490
47193
  },
47194
+ "406": {
47195
+ "$ref": "#/components/responses/unacceptable"
47196
+ },
46491
47197
  "500": {
46492
47198
  "$ref": "#/components/responses/internal_error"
46493
47199
  },
@@ -53062,586 +53768,6 @@
53062
53768
  "x-octokit": {}
53063
53769
  }
53064
53770
  },
53065
- "/repositories/{repository_id}/environments/{environment_name}/secrets": {
53066
- "get": {
53067
- "summary": "List environment secrets",
53068
- "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.",
53069
- "tags": [
53070
- "actions"
53071
- ],
53072
- "operationId": "actions/list-environment-secrets",
53073
- "externalDocs": {
53074
- "description": "API method documentation",
53075
- "url": "https://docs.github.com/rest/actions/secrets#list-environment-secrets"
53076
- },
53077
- "parameters": [
53078
- {
53079
- "$ref": "#/components/parameters/repository-id"
53080
- },
53081
- {
53082
- "$ref": "#/components/parameters/environment-name"
53083
- },
53084
- {
53085
- "$ref": "#/components/parameters/per-page"
53086
- },
53087
- {
53088
- "$ref": "#/components/parameters/page"
53089
- }
53090
- ],
53091
- "responses": {
53092
- "200": {
53093
- "description": "Response",
53094
- "content": {
53095
- "application/json": {
53096
- "schema": {
53097
- "type": "object",
53098
- "required": [
53099
- "total_count",
53100
- "secrets"
53101
- ],
53102
- "properties": {
53103
- "total_count": {
53104
- "type": "integer"
53105
- },
53106
- "secrets": {
53107
- "type": "array",
53108
- "items": {
53109
- "$ref": "#/components/schemas/actions-secret"
53110
- }
53111
- }
53112
- }
53113
- },
53114
- "examples": {
53115
- "default": {
53116
- "$ref": "#/components/examples/actions-secret-paginated"
53117
- }
53118
- }
53119
- }
53120
- },
53121
- "headers": {
53122
- "Link": {
53123
- "$ref": "#/components/headers/link"
53124
- }
53125
- }
53126
- }
53127
- },
53128
- "x-github": {
53129
- "githubCloudOnly": false,
53130
- "enabledForGitHubApps": true,
53131
- "category": "actions",
53132
- "subcategory": "secrets"
53133
- },
53134
- "x-octokit": {}
53135
- }
53136
- },
53137
- "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
53138
- "get": {
53139
- "summary": "Get an environment public key",
53140
- "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.",
53141
- "tags": [
53142
- "actions"
53143
- ],
53144
- "operationId": "actions/get-environment-public-key",
53145
- "externalDocs": {
53146
- "description": "API method documentation",
53147
- "url": "https://docs.github.com/rest/actions/secrets#get-an-environment-public-key"
53148
- },
53149
- "parameters": [
53150
- {
53151
- "$ref": "#/components/parameters/repository-id"
53152
- },
53153
- {
53154
- "$ref": "#/components/parameters/environment-name"
53155
- }
53156
- ],
53157
- "responses": {
53158
- "200": {
53159
- "description": "Response",
53160
- "content": {
53161
- "application/json": {
53162
- "schema": {
53163
- "$ref": "#/components/schemas/actions-public-key"
53164
- },
53165
- "examples": {
53166
- "default": {
53167
- "$ref": "#/components/examples/actions-public-key"
53168
- }
53169
- }
53170
- }
53171
- }
53172
- }
53173
- },
53174
- "x-github": {
53175
- "githubCloudOnly": false,
53176
- "enabledForGitHubApps": true,
53177
- "category": "actions",
53178
- "subcategory": "secrets"
53179
- },
53180
- "x-octokit": {}
53181
- }
53182
- },
53183
- "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
53184
- "get": {
53185
- "summary": "Get an environment secret",
53186
- "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.",
53187
- "tags": [
53188
- "actions"
53189
- ],
53190
- "operationId": "actions/get-environment-secret",
53191
- "externalDocs": {
53192
- "description": "API method documentation",
53193
- "url": "https://docs.github.com/rest/actions/secrets#get-an-environment-secret"
53194
- },
53195
- "parameters": [
53196
- {
53197
- "$ref": "#/components/parameters/repository-id"
53198
- },
53199
- {
53200
- "$ref": "#/components/parameters/environment-name"
53201
- },
53202
- {
53203
- "$ref": "#/components/parameters/secret-name"
53204
- }
53205
- ],
53206
- "responses": {
53207
- "200": {
53208
- "description": "Response",
53209
- "content": {
53210
- "application/json": {
53211
- "schema": {
53212
- "$ref": "#/components/schemas/actions-secret"
53213
- },
53214
- "examples": {
53215
- "default": {
53216
- "$ref": "#/components/examples/actions-secret"
53217
- }
53218
- }
53219
- }
53220
- }
53221
- }
53222
- },
53223
- "x-github": {
53224
- "githubCloudOnly": false,
53225
- "enabledForGitHubApps": true,
53226
- "category": "actions",
53227
- "subcategory": "secrets"
53228
- },
53229
- "x-octokit": {}
53230
- },
53231
- "put": {
53232
- "summary": "Create or update an environment secret",
53233
- "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/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.",
53234
- "tags": [
53235
- "actions"
53236
- ],
53237
- "operationId": "actions/create-or-update-environment-secret",
53238
- "externalDocs": {
53239
- "description": "API method documentation",
53240
- "url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret"
53241
- },
53242
- "parameters": [
53243
- {
53244
- "$ref": "#/components/parameters/repository-id"
53245
- },
53246
- {
53247
- "$ref": "#/components/parameters/environment-name"
53248
- },
53249
- {
53250
- "$ref": "#/components/parameters/secret-name"
53251
- }
53252
- ],
53253
- "requestBody": {
53254
- "required": true,
53255
- "content": {
53256
- "application/json": {
53257
- "schema": {
53258
- "type": "object",
53259
- "properties": {
53260
- "encrypted_value": {
53261
- "type": "string",
53262
- "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/rest/actions/secrets#get-an-environment-public-key) endpoint.",
53263
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
53264
- },
53265
- "key_id": {
53266
- "type": "string",
53267
- "description": "ID of the key you used to encrypt the secret."
53268
- }
53269
- },
53270
- "required": [
53271
- "encrypted_value",
53272
- "key_id"
53273
- ]
53274
- },
53275
- "examples": {
53276
- "default": {
53277
- "value": {
53278
- "encrypted_value": "c2VjcmV0",
53279
- "key_id": "012345678912345678"
53280
- }
53281
- }
53282
- }
53283
- }
53284
- }
53285
- },
53286
- "responses": {
53287
- "201": {
53288
- "description": "Response when creating a secret",
53289
- "content": {
53290
- "application/json": {
53291
- "schema": {
53292
- "$ref": "#/components/schemas/empty-object"
53293
- },
53294
- "examples": {
53295
- "default": {
53296
- "value": null
53297
- }
53298
- }
53299
- }
53300
- }
53301
- },
53302
- "204": {
53303
- "description": "Response when updating a secret"
53304
- }
53305
- },
53306
- "x-github": {
53307
- "githubCloudOnly": false,
53308
- "enabledForGitHubApps": true,
53309
- "category": "actions",
53310
- "subcategory": "secrets"
53311
- },
53312
- "x-octokit": {}
53313
- },
53314
- "delete": {
53315
- "summary": "Delete an environment secret",
53316
- "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.",
53317
- "tags": [
53318
- "actions"
53319
- ],
53320
- "operationId": "actions/delete-environment-secret",
53321
- "externalDocs": {
53322
- "description": "API method documentation",
53323
- "url": "https://docs.github.com/rest/actions/secrets#delete-an-environment-secret"
53324
- },
53325
- "parameters": [
53326
- {
53327
- "$ref": "#/components/parameters/repository-id"
53328
- },
53329
- {
53330
- "$ref": "#/components/parameters/environment-name"
53331
- },
53332
- {
53333
- "$ref": "#/components/parameters/secret-name"
53334
- }
53335
- ],
53336
- "responses": {
53337
- "204": {
53338
- "description": "Default response"
53339
- }
53340
- },
53341
- "x-github": {
53342
- "githubCloudOnly": false,
53343
- "enabledForGitHubApps": true,
53344
- "category": "actions",
53345
- "subcategory": "secrets"
53346
- },
53347
- "x-octokit": {}
53348
- }
53349
- },
53350
- "/repositories/{repository_id}/environments/{environment_name}/variables": {
53351
- "get": {
53352
- "summary": "List environment variables",
53353
- "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.",
53354
- "tags": [
53355
- "actions"
53356
- ],
53357
- "operationId": "actions/list-environment-variables",
53358
- "externalDocs": {
53359
- "description": "API method documentation",
53360
- "url": "https://docs.github.com/rest/actions/variables#list-environment-variables"
53361
- },
53362
- "parameters": [
53363
- {
53364
- "$ref": "#/components/parameters/repository-id"
53365
- },
53366
- {
53367
- "$ref": "#/components/parameters/environment-name"
53368
- },
53369
- {
53370
- "$ref": "#/components/parameters/variables-per-page"
53371
- },
53372
- {
53373
- "$ref": "#/components/parameters/page"
53374
- }
53375
- ],
53376
- "responses": {
53377
- "200": {
53378
- "description": "Response",
53379
- "content": {
53380
- "application/json": {
53381
- "schema": {
53382
- "type": "object",
53383
- "required": [
53384
- "total_count",
53385
- "variables"
53386
- ],
53387
- "properties": {
53388
- "total_count": {
53389
- "type": "integer"
53390
- },
53391
- "variables": {
53392
- "type": "array",
53393
- "items": {
53394
- "$ref": "#/components/schemas/actions-variable"
53395
- }
53396
- }
53397
- }
53398
- },
53399
- "examples": {
53400
- "default": {
53401
- "$ref": "#/components/examples/actions-variables-paginated"
53402
- }
53403
- }
53404
- }
53405
- },
53406
- "headers": {
53407
- "Link": {
53408
- "$ref": "#/components/headers/link"
53409
- }
53410
- }
53411
- }
53412
- },
53413
- "x-github": {
53414
- "githubCloudOnly": false,
53415
- "enabledForGitHubApps": true,
53416
- "category": "actions",
53417
- "subcategory": "variables"
53418
- },
53419
- "x-octokit": {}
53420
- },
53421
- "post": {
53422
- "summary": "Create an environment variable",
53423
- "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.",
53424
- "tags": [
53425
- "actions"
53426
- ],
53427
- "operationId": "actions/create-environment-variable",
53428
- "externalDocs": {
53429
- "description": "API method documentation",
53430
- "url": "https://docs.github.com/rest/actions/variables#create-an-environment-variable"
53431
- },
53432
- "parameters": [
53433
- {
53434
- "$ref": "#/components/parameters/repository-id"
53435
- },
53436
- {
53437
- "$ref": "#/components/parameters/environment-name"
53438
- }
53439
- ],
53440
- "requestBody": {
53441
- "required": true,
53442
- "content": {
53443
- "application/json": {
53444
- "schema": {
53445
- "type": "object",
53446
- "properties": {
53447
- "name": {
53448
- "type": "string",
53449
- "description": "The name of the variable."
53450
- },
53451
- "value": {
53452
- "type": "string",
53453
- "description": "The value of the variable."
53454
- }
53455
- },
53456
- "required": [
53457
- "name",
53458
- "value"
53459
- ]
53460
- },
53461
- "examples": {
53462
- "default": {
53463
- "value": {
53464
- "name": "USERNAME",
53465
- "value": "octocat"
53466
- }
53467
- }
53468
- }
53469
- }
53470
- }
53471
- },
53472
- "responses": {
53473
- "201": {
53474
- "description": "Response",
53475
- "content": {
53476
- "application/json": {
53477
- "schema": {
53478
- "$ref": "#/components/schemas/empty-object"
53479
- },
53480
- "examples": {
53481
- "default": {
53482
- "value": null
53483
- }
53484
- }
53485
- }
53486
- }
53487
- }
53488
- },
53489
- "x-github": {
53490
- "githubCloudOnly": false,
53491
- "enabledForGitHubApps": true,
53492
- "category": "actions",
53493
- "subcategory": "variables"
53494
- },
53495
- "x-octokit": {}
53496
- }
53497
- },
53498
- "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
53499
- "get": {
53500
- "summary": "Get an environment variable",
53501
- "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.",
53502
- "tags": [
53503
- "actions"
53504
- ],
53505
- "operationId": "actions/get-environment-variable",
53506
- "externalDocs": {
53507
- "description": "API method documentation",
53508
- "url": "https://docs.github.com/rest/actions/variables#get-an-environment-variable"
53509
- },
53510
- "parameters": [
53511
- {
53512
- "$ref": "#/components/parameters/repository-id"
53513
- },
53514
- {
53515
- "$ref": "#/components/parameters/environment-name"
53516
- },
53517
- {
53518
- "$ref": "#/components/parameters/variable-name"
53519
- }
53520
- ],
53521
- "responses": {
53522
- "200": {
53523
- "description": "Response",
53524
- "content": {
53525
- "application/json": {
53526
- "schema": {
53527
- "$ref": "#/components/schemas/actions-variable"
53528
- },
53529
- "examples": {
53530
- "default": {
53531
- "$ref": "#/components/examples/actions-variable"
53532
- }
53533
- }
53534
- }
53535
- }
53536
- }
53537
- },
53538
- "x-github": {
53539
- "githubCloudOnly": false,
53540
- "enabledForGitHubApps": true,
53541
- "category": "actions",
53542
- "subcategory": "variables"
53543
- },
53544
- "x-octokit": {}
53545
- },
53546
- "patch": {
53547
- "summary": "Update an environment variable",
53548
- "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.",
53549
- "tags": [
53550
- "actions"
53551
- ],
53552
- "operationId": "actions/update-environment-variable",
53553
- "externalDocs": {
53554
- "description": "API method documentation",
53555
- "url": "https://docs.github.com/rest/actions/variables#update-an-environment-variable"
53556
- },
53557
- "parameters": [
53558
- {
53559
- "$ref": "#/components/parameters/repository-id"
53560
- },
53561
- {
53562
- "$ref": "#/components/parameters/variable-name"
53563
- },
53564
- {
53565
- "$ref": "#/components/parameters/environment-name"
53566
- }
53567
- ],
53568
- "requestBody": {
53569
- "required": true,
53570
- "content": {
53571
- "application/json": {
53572
- "schema": {
53573
- "type": "object",
53574
- "properties": {
53575
- "name": {
53576
- "type": "string",
53577
- "description": "The name of the variable."
53578
- },
53579
- "value": {
53580
- "type": "string",
53581
- "description": "The value of the variable."
53582
- }
53583
- }
53584
- },
53585
- "examples": {
53586
- "default": {
53587
- "value": {
53588
- "name": "USERNAME",
53589
- "value": "octocat"
53590
- }
53591
- }
53592
- }
53593
- }
53594
- }
53595
- },
53596
- "responses": {
53597
- "204": {
53598
- "description": "Response"
53599
- }
53600
- },
53601
- "x-github": {
53602
- "githubCloudOnly": false,
53603
- "enabledForGitHubApps": true,
53604
- "category": "actions",
53605
- "subcategory": "variables"
53606
- },
53607
- "x-octokit": {}
53608
- },
53609
- "delete": {
53610
- "summary": "Delete an environment variable",
53611
- "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.",
53612
- "tags": [
53613
- "actions"
53614
- ],
53615
- "operationId": "actions/delete-environment-variable",
53616
- "externalDocs": {
53617
- "description": "API method documentation",
53618
- "url": "https://docs.github.com/rest/actions/variables#delete-an-environment-variable"
53619
- },
53620
- "parameters": [
53621
- {
53622
- "$ref": "#/components/parameters/repository-id"
53623
- },
53624
- {
53625
- "$ref": "#/components/parameters/variable-name"
53626
- },
53627
- {
53628
- "$ref": "#/components/parameters/environment-name"
53629
- }
53630
- ],
53631
- "responses": {
53632
- "204": {
53633
- "description": "Response"
53634
- }
53635
- },
53636
- "x-github": {
53637
- "githubCloudOnly": false,
53638
- "enabledForGitHubApps": true,
53639
- "category": "actions",
53640
- "subcategory": "variables"
53641
- },
53642
- "x-octokit": {}
53643
- }
53644
- },
53645
53771
  "/search/code": {
53646
53772
  "get": {
53647
53773
  "summary": "Search code",
@@ -63499,7 +63625,7 @@
63499
63625
  "/users/{username}/hovercard": {
63500
63626
  "get": {
63501
63627
  "summary": "Get contextual information for a user",
63502
- "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.",
63628
+ "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.",
63503
63629
  "tags": [
63504
63630
  "users"
63505
63631
  ],
@@ -83146,8 +83272,7 @@
83146
83272
  },
83147
83273
  "repository-dispatch-sample.collected": {
83148
83274
  "post": {
83149
- "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/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.",
83150
- "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.",
83275
+ "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/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.",
83151
83276
  "operationId": "repository-dispatch/sample.collected",
83152
83277
  "externalDocs": {
83153
83278
  "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch"
@@ -87754,7 +87879,8 @@
87754
87879
  },
87755
87880
  "hub_url": {
87756
87881
  "type": "string",
87757
- "format": "uri-template"
87882
+ "format": "uri-template",
87883
+ "deprecated": true
87758
87884
  },
87759
87885
  "issue_search_url": {
87760
87886
  "type": "string",
@@ -87850,7 +87976,6 @@
87850
87976
  "followers_url",
87851
87977
  "following_url",
87852
87978
  "gists_url",
87853
- "hub_url",
87854
87979
  "issue_search_url",
87855
87980
  "issues_url",
87856
87981
  "keys_url",
@@ -99906,6 +100031,43 @@
99906
100031
  }
99907
100032
  }
99908
100033
  },
100034
+ "repository-rule-params-code-scanning-threshold": {
100035
+ "title": "CodeScanningThreshold",
100036
+ "description": "A tool and its thresholds.",
100037
+ "type": "object",
100038
+ "properties": {
100039
+ "alerts": {
100040
+ "type": "string",
100041
+ "description": "Code scanning alert threshold",
100042
+ "enum": [
100043
+ "none",
100044
+ "errors",
100045
+ "errors_and_warnings",
100046
+ "all"
100047
+ ]
100048
+ },
100049
+ "security_alerts": {
100050
+ "type": "string",
100051
+ "description": "Code scanning security alert threshold.",
100052
+ "enum": [
100053
+ "none",
100054
+ "critical",
100055
+ "high_or_higher",
100056
+ "medium_or_higher",
100057
+ "all"
100058
+ ]
100059
+ },
100060
+ "tool": {
100061
+ "type": "string",
100062
+ "description": "The name of a code scanning tool"
100063
+ }
100064
+ },
100065
+ "required": [
100066
+ "alerts",
100067
+ "security_alerts",
100068
+ "tool"
100069
+ ]
100070
+ },
99909
100071
  "repository-rule": {
99910
100072
  "title": "Repository Rule",
99911
100073
  "type": "object",
@@ -102509,7 +102671,9 @@
102509
102671
  "queued",
102510
102672
  "in_progress",
102511
102673
  "completed",
102512
- "waiting"
102674
+ "waiting",
102675
+ "requested",
102676
+ "pending"
102513
102677
  ]
102514
102678
  },
102515
102679
  "conclusion": {
@@ -105197,13 +105361,16 @@
105197
105361
  "nullable": true
105198
105362
  },
105199
105363
  "status": {
105200
- "description": "The phase of the lifecycle that the check is currently in.",
105364
+ "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.",
105201
105365
  "example": "queued",
105202
105366
  "type": "string",
105203
105367
  "enum": [
105204
105368
  "queued",
105205
105369
  "in_progress",
105206
- "completed"
105370
+ "completed",
105371
+ "waiting",
105372
+ "requested",
105373
+ "pending"
105207
105374
  ]
105208
105375
  },
105209
105376
  "conclusion": {
@@ -105481,11 +105648,15 @@
105481
105648
  },
105482
105649
  "status": {
105483
105650
  "type": "string",
105651
+ "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.",
105484
105652
  "example": "completed",
105485
105653
  "enum": [
105486
105654
  "queued",
105487
105655
  "in_progress",
105488
- "completed"
105656
+ "completed",
105657
+ "waiting",
105658
+ "requested",
105659
+ "pending"
105489
105660
  ],
105490
105661
  "nullable": true
105491
105662
  },
@@ -115617,6 +115788,64 @@
115617
115788
  "commit_url"
115618
115789
  ]
115619
115790
  },
115791
+ "secret-scanning-location-wiki-commit": {
115792
+ "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.",
115793
+ "type": "object",
115794
+ "properties": {
115795
+ "path": {
115796
+ "type": "string",
115797
+ "description": "The file path of the wiki page",
115798
+ "example": "/example/Home.md"
115799
+ },
115800
+ "start_line": {
115801
+ "type": "number",
115802
+ "description": "Line number at which the secret starts in the file"
115803
+ },
115804
+ "end_line": {
115805
+ "type": "number",
115806
+ "description": "Line number at which the secret ends in the file"
115807
+ },
115808
+ "start_column": {
115809
+ "type": "number",
115810
+ "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII."
115811
+ },
115812
+ "end_column": {
115813
+ "type": "number",
115814
+ "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII."
115815
+ },
115816
+ "blob_sha": {
115817
+ "type": "string",
115818
+ "description": "SHA-1 hash ID of the associated blob",
115819
+ "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b"
115820
+ },
115821
+ "page_url": {
115822
+ "type": "string",
115823
+ "description": "The GitHub URL to get the associated wiki page",
115824
+ "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
115825
+ },
115826
+ "commit_sha": {
115827
+ "type": "string",
115828
+ "description": "SHA-1 hash ID of the associated commit",
115829
+ "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5"
115830
+ },
115831
+ "commit_url": {
115832
+ "type": "string",
115833
+ "description": "The GitHub URL to get the associated wiki commit",
115834
+ "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
115835
+ }
115836
+ },
115837
+ "required": [
115838
+ "path",
115839
+ "start_line",
115840
+ "end_line",
115841
+ "start_column",
115842
+ "end_column",
115843
+ "blob_sha",
115844
+ "page_url",
115845
+ "commit_sha",
115846
+ "commit_url"
115847
+ ]
115848
+ },
115620
115849
  "secret-scanning-location-issue-title": {
115621
115850
  "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.",
115622
115851
  "type": "object",
@@ -115789,6 +116018,7 @@
115789
116018
  "type": "string",
115790
116019
  "enum": [
115791
116020
  "commit",
116021
+ "wiki_commit",
115792
116022
  "issue_title",
115793
116023
  "issue_body",
115794
116024
  "issue_comment",
@@ -115809,6 +116039,9 @@
115809
116039
  {
115810
116040
  "$ref": "#/components/schemas/secret-scanning-location-commit"
115811
116041
  },
116042
+ {
116043
+ "$ref": "#/components/schemas/secret-scanning-location-wiki-commit"
116044
+ },
115812
116045
  {
115813
116046
  "$ref": "#/components/schemas/secret-scanning-location-issue-title"
115814
116047
  },
@@ -115844,11 +116077,7 @@
115844
116077
  }
115845
116078
  ]
115846
116079
  }
115847
- },
115848
- "required": [
115849
- "type",
115850
- "details"
115851
- ]
116080
+ }
115852
116081
  },
115853
116082
  "repository-advisory-create": {
115854
116083
  "type": "object",
@@ -172167,6 +172396,7 @@
172167
172396
  "type": "object",
172168
172397
  "properties": {
172169
172398
  "permission": {
172399
+ "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.",
172170
172400
  "type": "object",
172171
172401
  "properties": {
172172
172402
  "to": {
@@ -172181,6 +172411,18 @@
172181
172411
  "required": [
172182
172412
  "to"
172183
172413
  ]
172414
+ },
172415
+ "role_name": {
172416
+ "description": "The role assigned to the collaborator.",
172417
+ "type": "object",
172418
+ "properties": {
172419
+ "to": {
172420
+ "type": "string"
172421
+ }
172422
+ },
172423
+ "required": [
172424
+ "to"
172425
+ ]
172184
172426
  }
172185
172427
  }
172186
172428
  },
@@ -256930,7 +257172,7 @@
256930
257172
  "type": "string"
256931
257173
  },
256932
257174
  "commits": {
256933
- "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/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.",
257175
+ "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/rest/commits) to fetch additional commits.",
256934
257176
  "type": "array",
256935
257177
  "items": {
256936
257178
  "title": "Commit",
@@ -262767,9 +263009,7 @@
262767
263009
  "properties": {
262768
263010
  "action": {
262769
263011
  "type": "string",
262770
- "enum": [
262771
- "sample.collected"
262772
- ]
263012
+ "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
262773
263013
  },
262774
263014
  "branch": {
262775
263015
  "type": "string"
@@ -262777,7 +263017,8 @@
262777
263017
  "client_payload": {
262778
263018
  "type": "object",
262779
263019
  "nullable": true,
262780
- "additionalProperties": true
263020
+ "additionalProperties": true,
263021
+ "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
262781
263022
  },
262782
263023
  "enterprise": {
262783
263024
  "$ref": "#/components/schemas/enterprise-webhooks"
@@ -301345,6 +301586,20 @@
301345
301586
  "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b"
301346
301587
  }
301347
301588
  },
301589
+ {
301590
+ "type": "wiki_commit",
301591
+ "details": {
301592
+ "path": "/example/Home.md",
301593
+ "start_line": 1,
301594
+ "end_line": 1,
301595
+ "start_column": 1,
301596
+ "end_column": 64,
301597
+ "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b",
301598
+ "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5",
301599
+ "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5",
301600
+ "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
301601
+ }
301602
+ },
301348
301603
  {
301349
301604
  "type": "issue_title",
301350
301605
  "details": {
@@ -309077,7 +309332,7 @@
309077
309332
  },
309078
309333
  "workflow-run-status": {
309079
309334
  "name": "status",
309080
- "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`.",
309335
+ "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`.",
309081
309336
  "in": "query",
309082
309337
  "required": false,
309083
309338
  "schema": {
@@ -309331,6 +309586,17 @@
309331
309586
  "type": "integer"
309332
309587
  }
309333
309588
  },
309589
+ "git-ref-only": {
309590
+ "name": "ref",
309591
+ "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.",
309592
+ "in": "path",
309593
+ "required": true,
309594
+ "example": "heads/feature-a",
309595
+ "schema": {
309596
+ "type": "string"
309597
+ },
309598
+ "x-multi-segment": true
309599
+ },
309334
309600
  "since-user": {
309335
309601
  "name": "since",
309336
309602
  "description": "A user ID. Only return users with an ID greater than this ID.",
@@ -309887,6 +310153,16 @@
309887
310153
  }
309888
310154
  }
309889
310155
  }
310156
+ },
310157
+ "unacceptable": {
310158
+ "description": "Unacceptable",
310159
+ "content": {
310160
+ "application/json": {
310161
+ "schema": {
310162
+ "$ref": "#/components/schemas/basic-error"
310163
+ }
310164
+ }
310165
+ }
309890
310166
  }
309891
310167
  },
309892
310168
  "headers": {