From 312b23bf8977f17d59b91d8aeaadc550c2ce794d Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Mon, 1 Apr 2024 14:12:47 -0500 Subject: [PATCH] Breaking Change: Updates OpenAPI version to 14.1.0, adds http status 409 to many endpoints, adds statuses [requested, pending] to workflow.run.status, updates reference path parameter.commit-ref to parameter.git-ref-only, updates many types from field?: unknown; to a more specific type field?: Record | null, BREAKING CHANGE: Updates multiple endpoints to use `owner` + `repo` in place of `repository_id` (#402) --- cache/api.github.com.json | 1413 +++++++++------- cache/ghec.json | 1487 ++++++++++------- cache/ghes-3.10.json | 1365 ++++++++------- cache/ghes-3.11.json | 1397 +++++++++------- cache/ghes-3.12.json | 1397 +++++++++------- cache/ghes-3.8.json | 1365 ++++++++------- cache/ghes-3.9.json | 1365 ++++++++------- cache/github.ae.json | 2 +- packages/openapi-types-ghec/package.json | 2 +- packages/openapi-types-ghec/types.d.ts | 1165 +++++++------ packages/openapi-types-ghes-3.10/package.json | 2 +- packages/openapi-types-ghes-3.10/types.d.ts | 1204 +++++++------ packages/openapi-types-ghes-3.11/package.json | 2 +- packages/openapi-types-ghes-3.11/types.d.ts | 1229 ++++++++------ packages/openapi-types-ghes-3.12/package.json | 2 +- packages/openapi-types-ghes-3.12/types.d.ts | 1229 ++++++++------ packages/openapi-types-ghes-3.8/package.json | 2 +- packages/openapi-types-ghes-3.8/types.d.ts | 1204 +++++++------ packages/openapi-types-ghes-3.9/package.json | 2 +- packages/openapi-types-ghes-3.9/types.d.ts | 1204 +++++++------ packages/openapi-types-github.ae/package.json | 2 +- packages/openapi-types-github.ae/types.d.ts | 116 +- packages/openapi-types/package.json | 2 +- packages/openapi-types/types.d.ts | 1119 +++++++------ 24 files changed, 10139 insertions(+), 8138 deletions(-) diff --git a/cache/api.github.com.json b/cache/api.github.com.json index ca060681d..c636a9eb8 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "14.0.0", + "version": "14.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -3039,7 +3039,7 @@ "/feeds": { "get": { "summary": "Get feeds", - "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.", + "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.", "tags": [ "activity" ], @@ -5967,7 +5967,7 @@ "/organizations": { "get": { "summary": "List organizations", - "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.", + "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.", "tags": [ "orgs" ], @@ -9912,6 +9912,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "422": { + "description": "There is a problem with your account's associated payment method." + }, "500": { "$ref": "#/components/responses/internal_error" } @@ -30240,11 +30243,14 @@ }, "status": { "type": "string", - "description": "The current status.", + "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -33915,6 +33921,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -34146,6 +34155,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -34205,6 +34217,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" }, @@ -34588,7 +34603,7 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "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. |", + "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. |", "tags": [ "repos" ], @@ -37529,6 +37544,616 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + "get": { + "summary": "List environment secrets", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#list-environment-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + "get": { + "summary": "Get an environment public key", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#get-an-environment-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + "get": { + "summary": "Get an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#get-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "put": { + "summary": "Create or update an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "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.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + }, + "required": [ + "encrypted_value", + "key_id" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#delete-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Default response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + "get": { + "summary": "List environment variables", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#list-environment-variables" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variables-per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-variable" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variables-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/create-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#create-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + }, + "required": [ + "name", + "value" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + "get": { + "summary": "Get an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#get-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-variable" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variable" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/update-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#update-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#delete-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", @@ -37901,6 +38526,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -38055,6 +38683,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -38109,6 +38740,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -38140,7 +38774,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -38166,6 +38800,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -38197,7 +38834,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -38218,6 +38855,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -38305,6 +38945,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -38321,7 +38964,7 @@ "/repos/{owner}/{repo}/git/refs/{ref}": { "patch": { "summary": "Update a reference", - "description": "", + "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.", "tags": [ "git" ], @@ -38338,15 +38981,7 @@ "$ref": "#/components/parameters/repo" }, { - "name": "ref", - "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.", - "in": "path", - "required": true, - "example": "heads/featureA", - "schema": { - "type": "string" - }, - "x-multi-segment": true + "$ref": "#/components/parameters/git-ref-only" } ], "requestBody": { @@ -38397,6 +39032,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -38411,7 +39049,7 @@ }, "delete": { "summary": "Delete a reference", - "description": "", + "description": "Deletes the provided reference.", "tags": [ "git" ], @@ -38428,13 +39066,16 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { "204": { "description": "Response" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -38569,6 +39210,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -38628,6 +39272,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -38765,6 +39412,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -38839,6 +39489,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -43706,6 +44359,9 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/git-ref" } ], "responses": { @@ -45342,6 +45998,64 @@ } }, "/repos/{owner}/{repo}/private-vulnerability-reporting": { + "get": { + "summary": "Check if private vulnerability reporting is enabled for a repository", + "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)\".", + "tags": [ + "repos" + ], + "operationId": "repos/check-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Private vulnerability reporting status", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether or not private vulnerability reporting is enabled for the repository." + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/bad_request" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + }, + "x-octokit": {} + }, "put": { "summary": "Enable private vulnerability reporting for a repository", "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).\"", @@ -53062,586 +53776,6 @@ "x-octokit": {} } }, - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - "get": { - "summary": "List environment secrets", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-secrets", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#list-environment-secrets" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-secret" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - "get": { - "summary": "Get an environment public key", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#get-an-environment-public-key" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-public-key" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-public-key" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - "get": { - "summary": "Get an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#get-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-secret" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "put": { - "summary": "Create or update an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/create-or-update-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "encrypted_value": { - "type": "string", - "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.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "ID of the key you used to encrypt the secret." - } - }, - "required": [ - "encrypted_value", - "key_id" - ] - }, - "examples": { - "default": { - "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response when creating a secret", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#delete-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "204": { - "description": "Default response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables": { - "get": { - "summary": "List environment variables", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-variables", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#list-environment-variables" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variables-per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-variable" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variables-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "post": { - "summary": "Create an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/create-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#create-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - }, - "required": [ - "name", - "value" - ] - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - "get": { - "summary": "Get an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#get-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variable-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-variable" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variable" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "patch": { - "summary": "Update an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/update-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#update-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - } - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#delete-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, "/search/code": { "get": { "summary": "Search code", @@ -63499,7 +63633,7 @@ "/users/{username}/hovercard": { "get": { "summary": "Get contextual information for a user", - "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.", + "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.", "tags": [ "users" ], @@ -99906,6 +100040,38 @@ } } }, + "repository-rule-params-thresholds": { + "title": "Thresholds", + "description": "This setting will not take effect unless at least one code scanning status check is enabled.", + "type": "object", + "properties": { + "code_scanning_alert_threshold": { + "type": "string", + "description": "Code scanning alert threshold", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "code_scanning_security_alert_threshold": { + "type": "string", + "description": "Code scanning security alert threshold.", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + } + }, + "required": [ + "code_scanning_alert_threshold", + "code_scanning_security_alert_threshold" + ] + }, "repository-rule": { "title": "Repository Rule", "type": "object", @@ -102509,7 +102675,9 @@ "queued", "in_progress", "completed", - "waiting" + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -105197,13 +105365,16 @@ "nullable": true }, "status": { - "description": "The phase of the lifecycle that the check is currently in.", + "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.", "example": "queued", "type": "string", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -105481,11 +105652,15 @@ }, "status": { "type": "string", + "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.", "example": "completed", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ], "nullable": true }, @@ -172167,6 +172342,7 @@ "type": "object", "properties": { "permission": { + "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.", "type": "object", "properties": { "to": { @@ -172181,6 +172357,18 @@ "required": [ "to" ] + }, + "role_name": { + "description": "The role assigned to the collaborator.", + "type": "object", + "properties": { + "to": { + "type": "string" + } + }, + "required": [ + "to" + ] } } }, @@ -256930,7 +257118,7 @@ "type": "string" }, "commits": { - "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.", + "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.", "type": "array", "items": { "title": "Commit", @@ -309077,7 +309265,7 @@ }, "workflow-run-status": { "name": "status", - "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`.", + "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`.", "in": "query", "required": false, "schema": { @@ -309331,6 +309519,17 @@ "type": "integer" } }, + "git-ref-only": { + "name": "ref", + "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, "since-user": { "name": "since", "description": "A user ID. Only return users with an ID greater than this ID.", diff --git a/cache/ghec.json b/cache/ghec.json index d70ccdfe9..37c25bcf9 100644 --- a/cache/ghec.json +++ b/cache/ghec.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "14.0.0", + "version": "14.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -5641,9 +5641,6 @@ } } } - }, - "403": { - "$ref": "#/components/responses/code_scanning_forbidden_read" } }, "x-github": { @@ -5845,7 +5842,7 @@ "/feeds": { "get": { "summary": "Get feeds", - "description": "GitHub Enterprise Cloud provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub Enterprise Cloud global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Cloud global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ "activity" ], @@ -8773,7 +8770,7 @@ "/organizations": { "get": { "summary": "List organizations", - "description": "Lists all organizations, in the order that they were created on GitHub Enterprise Cloud.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "tags": [ "orgs" ], @@ -13760,6 +13757,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "422": { + "description": "There is a problem with your account's associated payment method." + }, "500": { "$ref": "#/components/responses/internal_error" } @@ -22571,9 +22571,6 @@ } } } - }, - "403": { - "$ref": "#/components/responses/code_scanning_forbidden_read" } }, "x-github": { @@ -35346,11 +35343,14 @@ }, "status": { "type": "string", - "description": "The current status.", + "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -39029,6 +39029,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -39260,6 +39263,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -39319,6 +39325,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" }, @@ -39702,7 +39711,7 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "description": "Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -42643,6 +42652,616 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + "get": { + "summary": "List environment secrets", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + "get": { + "summary": "Get an environment public key", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + "get": { + "summary": "Get an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "put": { + "summary": "Create or update an environment secret", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + }, + "required": [ + "encrypted_value", + "key_id" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Default response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + "get": { + "summary": "List environment variables", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variables-per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-variable" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variables-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/create-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + }, + "required": [ + "name", + "value" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + "get": { + "summary": "Get an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-variable" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variable" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/update-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", @@ -43015,6 +43634,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -43169,6 +43791,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -43223,6 +43848,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -43254,7 +43882,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -43280,6 +43908,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -43311,7 +43942,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -43332,6 +43963,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -43419,6 +44053,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -43435,7 +44072,7 @@ "/repos/{owner}/{repo}/git/refs/{ref}": { "patch": { "summary": "Update a reference", - "description": "", + "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.", "tags": [ "git" ], @@ -43452,15 +44089,7 @@ "$ref": "#/components/parameters/repo" }, { - "name": "ref", - "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.", - "in": "path", - "required": true, - "example": "heads/featureA", - "schema": { - "type": "string" - }, - "x-multi-segment": true + "$ref": "#/components/parameters/git-ref-only" } ], "requestBody": { @@ -43511,6 +44140,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -43525,7 +44157,7 @@ }, "delete": { "summary": "Delete a reference", - "description": "", + "description": "Deletes the provided reference.", "tags": [ "git" ], @@ -43542,13 +44174,16 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { "204": { "description": "Response" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -43683,6 +44318,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -43742,6 +44380,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -43879,6 +44520,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -43953,6 +44597,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -48889,6 +49536,9 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/git-ref" } ], "responses": { @@ -50529,6 +51179,64 @@ } }, "/repos/{owner}/{repo}/private-vulnerability-reporting": { + "get": { + "summary": "Check if private vulnerability reporting is enabled for a repository", + "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", + "tags": [ + "repos" + ], + "operationId": "repos/check-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Private vulnerability reporting status", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether or not private vulnerability reporting is enabled for the repository." + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/bad_request" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + }, + "x-octokit": {} + }, "put": { "summary": "Enable private vulnerability reporting for a repository", "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", @@ -58249,587 +58957,7 @@ "x-octokit": {} } }, - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - "get": { - "summary": "List environment secrets", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-secrets", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-secret" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - "get": { - "summary": "Get an environment public key", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-public-key" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-public-key" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - "get": { - "summary": "Get an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-secret" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "put": { - "summary": "Create or update an environment secret", - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/create-or-update-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "encrypted_value": { - "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "ID of the key you used to encrypt the secret." - } - }, - "required": [ - "encrypted_value", - "key_id" - ] - }, - "examples": { - "default": { - "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response when creating a secret", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "204": { - "description": "Default response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables": { - "get": { - "summary": "List environment variables", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-variables", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variables-per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-variable" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variables-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "post": { - "summary": "Create an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/create-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - }, - "required": [ - "name", - "value" - ] - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - "get": { - "summary": "Get an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variable-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-variable" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variable" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "patch": { - "summary": "Update an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/update-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - } - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, - "/scim/v2/Groups": { + "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", @@ -58868,6 +58996,9 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -58921,6 +59052,11 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-group" }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], "requestBody": { "required": true, "content": { @@ -58986,7 +59122,7 @@ "x-octokit": {} } }, - "/scim/v2/Groups/{scim_group_id}": { + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nGets information about a SCIM group.", @@ -59004,6 +59140,9 @@ }, { "$ref": "#/components/parameters/excluded-attributes" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -59063,6 +59202,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -59170,6 +59312,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -59287,6 +59432,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -59321,7 +59469,7 @@ "x-octokit": {} } }, - "/scim/v2/Users": { + "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.", @@ -59356,6 +59504,9 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -59409,6 +59560,11 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-user" }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], "requestBody": { "required": true, "content": { @@ -59474,7 +59630,7 @@ "x-octokit": {} } }, - "/scim/v2/Users/{scim_user_id}": { + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", "description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nGets information about a SCIM user.", @@ -59489,6 +59645,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -59548,6 +59707,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -59625,6 +59787,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -59760,6 +59925,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -70525,7 +70693,7 @@ "/users/{username}/hovercard": { "get": { "summary": "Get contextual information for a user", - "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.", + "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.", "tags": [ "users" ], @@ -108405,6 +108573,38 @@ } } }, + "repository-rule-params-thresholds": { + "title": "Thresholds", + "description": "This setting will not take effect unless at least one code scanning status check is enabled.", + "type": "object", + "properties": { + "code_scanning_alert_threshold": { + "type": "string", + "description": "Code scanning alert threshold", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "code_scanning_security_alert_threshold": { + "type": "string", + "description": "Code scanning security alert threshold.", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + } + }, + "required": [ + "code_scanning_alert_threshold", + "code_scanning_security_alert_threshold" + ] + }, "repository-rule": { "title": "Repository Rule", "type": "object", @@ -110935,7 +111135,9 @@ "queued", "in_progress", "completed", - "waiting" + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -113624,13 +113826,16 @@ "nullable": true }, "status": { - "description": "The phase of the lifecycle that the check is currently in.", + "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.", "example": "queued", "type": "string", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -113908,11 +114113,15 @@ }, "status": { "type": "string", + "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.", "example": "completed", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ], "nullable": true }, @@ -181486,6 +181695,7 @@ "type": "object", "properties": { "permission": { + "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.", "type": "object", "properties": { "to": { @@ -181500,6 +181710,18 @@ "required": [ "to" ] + }, + "role_name": { + "description": "The role assigned to the collaborator.", + "type": "object", + "properties": { + "to": { + "type": "string" + } + }, + "required": [ + "to" + ] } } }, @@ -266249,7 +266471,7 @@ "type": "string" }, "commits": { - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest//rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.", + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest//rest/commits) to fetch additional commits.", "type": "array", "items": { "title": "Commit", @@ -319585,7 +319807,7 @@ }, "workflow-run-status": { "name": "status", - "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`.", + "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`.", "in": "query", "required": false, "schema": { @@ -319839,6 +320061,17 @@ "type": "integer" } }, + "git-ref-only": { + "name": "ref", + "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, "since-user": { "name": "since", "description": "A user ID. Only return users with an ID greater than this ID.", @@ -320307,16 +320540,6 @@ } } }, - "code_scanning_forbidden_read": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/basic-error" - } - } - } - }, "forbidden_gist": { "description": "Forbidden Gist", "content": { @@ -320406,6 +320629,16 @@ } } }, + "code_scanning_forbidden_read": { + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "code_scanning_forbidden_write": { "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", "content": { diff --git a/cache/ghes-3.10.json b/cache/ghes-3.10.json index 7df53b8ba..2c85746ec 100644 --- a/cache/ghes-3.10.json +++ b/cache/ghes-3.10.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "14.0.0", + "version": "14.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -8490,7 +8490,7 @@ "/feeds": { "get": { "summary": "Get feeds", - "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.10/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.10/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "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.10/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.10/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.10/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ "activity" ], @@ -11362,7 +11362,7 @@ "/organizations": { "get": { "summary": "List organizations", - "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.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "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.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "tags": [ "orgs" ], @@ -32707,11 +32707,14 @@ }, "status": { "type": "string", - "description": "The current status.", + "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -35366,6 +35369,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -35597,6 +35603,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -35656,6 +35665,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" }, @@ -35993,7 +36005,7 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "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.10/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.10/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.10/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. |", + "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.10/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.10/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.10/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. |", "tags": [ "repos" ], @@ -38919,6 +38931,616 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + "get": { + "summary": "List environment secrets", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#list-environment-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + "get": { + "summary": "Get an environment public key", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + "get": { + "summary": "Get an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "put": { + "summary": "Create or update an environment secret", + "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.10/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.", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "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.10/rest/actions/secrets#get-an-environment-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + }, + "required": [ + "encrypted_value", + "key_id" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#delete-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Default response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + "get": { + "summary": "List environment variables", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#list-environment-variables" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variables-per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-variable" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variables-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/create-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#create-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + }, + "required": [ + "name", + "value" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + "get": { + "summary": "Get an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#get-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-variable" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variable" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/update-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#update-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#delete-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", @@ -39291,6 +39913,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -39445,6 +40070,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -39499,6 +40127,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -39530,7 +40161,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -39556,6 +40187,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -39587,7 +40221,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -39608,6 +40242,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -39695,6 +40332,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -39711,7 +40351,7 @@ "/repos/{owner}/{repo}/git/refs/{ref}": { "patch": { "summary": "Update a reference", - "description": "", + "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.", "tags": [ "git" ], @@ -39728,15 +40368,7 @@ "$ref": "#/components/parameters/repo" }, { - "name": "ref", - "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.", - "in": "path", - "required": true, - "example": "heads/featureA", - "schema": { - "type": "string" - }, - "x-multi-segment": true + "$ref": "#/components/parameters/git-ref-only" } ], "requestBody": { @@ -39787,6 +40419,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -39801,7 +40436,7 @@ }, "delete": { "summary": "Delete a reference", - "description": "", + "description": "Deletes the provided reference.", "tags": [ "git" ], @@ -39818,13 +40453,16 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { "204": { "description": "Response" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -39959,6 +40597,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -40018,6 +40659,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -40155,6 +40799,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -40229,6 +40876,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -52092,587 +52742,7 @@ "x-octokit": {} } }, - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - "get": { - "summary": "List environment secrets", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-secrets", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#list-environment-secrets" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-secret" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - "get": { - "summary": "Get an environment public key", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-public-key" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-public-key" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-public-key" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - "get": { - "summary": "Get an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-secret" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "put": { - "summary": "Create or update an environment secret", - "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.10/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.", - "tags": [ - "actions" - ], - "operationId": "actions/create-or-update-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "encrypted_value": { - "type": "string", - "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.10/rest/actions/secrets#get-an-environment-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "ID of the key you used to encrypt the secret." - } - }, - "required": [ - "encrypted_value", - "key_id" - ] - }, - "examples": { - "default": { - "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response when creating a secret", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#delete-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "204": { - "description": "Default response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables": { - "get": { - "summary": "List environment variables", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-variables", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#list-environment-variables" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variables-per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-variable" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variables-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "post": { - "summary": "Create an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/create-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#create-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - }, - "required": [ - "name", - "value" - ] - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - "get": { - "summary": "Get an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#get-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variable-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-variable" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variable" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "patch": { - "summary": "Update an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/update-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#update-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - } - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#delete-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, - "/scim/v2/Groups": { + "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", "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.", @@ -52711,6 +52781,9 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -52764,6 +52837,11 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#provision-a-scim-enterprise-group" }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], "requestBody": { "required": true, "content": { @@ -52829,7 +52907,7 @@ "x-octokit": {} } }, - "/scim/v2/Groups/{scim_group_id}": { + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", "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.", @@ -52847,6 +52925,9 @@ }, { "$ref": "#/components/parameters/excluded-attributes" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -52906,6 +52987,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -53013,6 +53097,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -53130,6 +53217,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -53164,7 +53254,7 @@ "x-octokit": {} } }, - "/scim/v2/Users": { + "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", "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.", @@ -53199,6 +53289,9 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -53252,6 +53345,11 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#provision-a-scim-enterprise-user" }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], "requestBody": { "required": true, "content": { @@ -53317,7 +53415,7 @@ "x-octokit": {} } }, - "/scim/v2/Users/{scim_user_id}": { + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", "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.", @@ -53332,6 +53430,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -53391,6 +53492,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -53468,6 +53572,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -53603,6 +53710,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -62045,7 +62155,7 @@ "/users/{username}/hovercard": { "get": { "summary": "Get contextual information for a user", - "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.", + "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.", "tags": [ "users" ], @@ -101078,7 +101188,9 @@ "queued", "in_progress", "completed", - "waiting" + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -103549,13 +103661,16 @@ "nullable": true }, "status": { - "description": "The phase of the lifecycle that the check is currently in.", + "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.", "example": "queued", "type": "string", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -103833,11 +103948,15 @@ }, "status": { "type": "string", + "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.", "example": "completed", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ], "nullable": true }, @@ -167827,6 +167946,7 @@ "type": "object", "properties": { "permission": { + "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.", "type": "object", "properties": { "to": { @@ -167841,6 +167961,18 @@ "required": [ "to" ] + }, + "role_name": { + "description": "The role assigned to the collaborator.", + "type": "object", + "properties": { + "to": { + "type": "string" + } + }, + "required": [ + "to" + ] } } }, @@ -246387,7 +246519,7 @@ "type": "string" }, "commits": { - "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.10/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.", + "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.10/rest/commits) to fetch additional commits.", "type": "array", "items": { "title": "Commit", @@ -295546,7 +295678,7 @@ }, "workflow-run-status": { "name": "status", - "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`.", + "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`.", "in": "query", "required": false, "schema": { @@ -295800,6 +295932,17 @@ "type": "integer" } }, + "git-ref-only": { + "name": "ref", + "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, "invitation-id": { "name": "invitation_id", "description": "The unique identifier of the invitation.", diff --git a/cache/ghes-3.11.json b/cache/ghes-3.11.json index 2cdc95764..a30cad0ad 100644 --- a/cache/ghes-3.11.json +++ b/cache/ghes-3.11.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "14.0.0", + "version": "14.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -8770,7 +8770,7 @@ "/feeds": { "get": { "summary": "Get feeds", - "description": "GitHub Enterprise Server provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ "activity" ], @@ -11642,7 +11642,7 @@ "/organizations": { "get": { "summary": "List organizations", - "description": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "tags": [ "orgs" ], @@ -33601,11 +33601,14 @@ }, "status": { "type": "string", - "description": "The current status.", + "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -36260,6 +36263,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -36491,6 +36497,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -36550,6 +36559,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" }, @@ -36887,7 +36899,7 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "description": "Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -39817,6 +39829,616 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + "get": { + "summary": "List environment secrets", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#list-environment-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + "get": { + "summary": "Get an environment public key", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + "get": { + "summary": "Get an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "put": { + "summary": "Create or update an environment secret", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + }, + "required": [ + "encrypted_value", + "key_id" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#delete-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Default response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + "get": { + "summary": "List environment variables", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#list-environment-variables" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variables-per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-variable" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variables-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/create-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#create-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + }, + "required": [ + "name", + "value" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + "get": { + "summary": "Get an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#get-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-variable" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variable" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/update-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#update-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#delete-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", @@ -40189,6 +40811,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -40343,6 +40968,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -40397,6 +41025,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -40428,7 +41059,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -40454,6 +41085,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -40485,7 +41119,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -40506,6 +41140,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -40593,6 +41230,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -40609,7 +41249,7 @@ "/repos/{owner}/{repo}/git/refs/{ref}": { "patch": { "summary": "Update a reference", - "description": "", + "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.", "tags": [ "git" ], @@ -40626,15 +41266,7 @@ "$ref": "#/components/parameters/repo" }, { - "name": "ref", - "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.", - "in": "path", - "required": true, - "example": "heads/featureA", - "schema": { - "type": "string" - }, - "x-multi-segment": true + "$ref": "#/components/parameters/git-ref-only" } ], "requestBody": { @@ -40685,6 +41317,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -40699,7 +41334,7 @@ }, "delete": { "summary": "Delete a reference", - "description": "", + "description": "Deletes the provided reference.", "tags": [ "git" ], @@ -40716,13 +41351,16 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { "204": { "description": "Response" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -40857,6 +41495,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -40916,6 +41557,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -41053,6 +41697,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -41127,6 +41774,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -53512,587 +54162,7 @@ "x-octokit": {} } }, - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - "get": { - "summary": "List environment secrets", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-secrets", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#list-environment-secrets" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-secret" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - "get": { - "summary": "Get an environment public key", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-public-key" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-public-key" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-public-key" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - "get": { - "summary": "Get an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-secret" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "put": { - "summary": "Create or update an environment secret", - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/create-or-update-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "encrypted_value": { - "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "ID of the key you used to encrypt the secret." - } - }, - "required": [ - "encrypted_value", - "key_id" - ] - }, - "examples": { - "default": { - "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response when creating a secret", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#delete-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "204": { - "description": "Default response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables": { - "get": { - "summary": "List environment variables", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-variables", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#list-environment-variables" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variables-per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-variable" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variables-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "post": { - "summary": "Create an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/create-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#create-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - }, - "required": [ - "name", - "value" - ] - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - "get": { - "summary": "Get an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#get-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variable-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-variable" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variable" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "patch": { - "summary": "Update an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/update-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#update-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - } - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#delete-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, - "/scim/v2/Groups": { + "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", @@ -54131,6 +54201,9 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -54184,6 +54257,11 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#provision-a-scim-enterprise-group" }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], "requestBody": { "required": true, "content": { @@ -54249,7 +54327,7 @@ "x-octokit": {} } }, - "/scim/v2/Groups/{scim_group_id}": { + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group.", @@ -54267,6 +54345,9 @@ }, { "$ref": "#/components/parameters/excluded-attributes" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -54326,6 +54407,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -54433,6 +54517,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -54550,6 +54637,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -54584,7 +54674,7 @@ "x-octokit": {} } }, - "/scim/v2/Users": { + "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.", @@ -54619,6 +54709,9 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -54672,6 +54765,11 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#provision-a-scim-enterprise-user" }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], "requestBody": { "required": true, "content": { @@ -54737,7 +54835,7 @@ "x-octokit": {} } }, - "/scim/v2/Users/{scim_user_id}": { + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user.", @@ -54752,6 +54850,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -54811,6 +54912,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -54888,6 +54992,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -55023,6 +55130,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -63465,7 +63575,7 @@ "/users/{username}/hovercard": { "get": { "summary": "Get contextual information for a user", - "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.", + "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.", "tags": [ "users" ], @@ -102061,6 +102171,38 @@ } } }, + "repository-rule-params-thresholds": { + "title": "Thresholds", + "description": "This setting will not take effect unless at least one code scanning status check is enabled.", + "type": "object", + "properties": { + "code_scanning_alert_threshold": { + "type": "string", + "description": "Code scanning alert threshold", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "code_scanning_security_alert_threshold": { + "type": "string", + "description": "Code scanning security alert threshold.", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + } + }, + "required": [ + "code_scanning_alert_threshold", + "code_scanning_security_alert_threshold" + ] + }, "repository-rule": { "title": "Repository Rule", "type": "object", @@ -104166,7 +104308,9 @@ "queued", "in_progress", "completed", - "waiting" + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -106699,13 +106843,16 @@ "nullable": true }, "status": { - "description": "The phase of the lifecycle that the check is currently in.", + "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.", "example": "queued", "type": "string", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -106983,11 +107130,15 @@ }, "status": { "type": "string", + "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.", "example": "completed", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ], "nullable": true }, @@ -171241,6 +171392,7 @@ "type": "object", "properties": { "permission": { + "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.", "type": "object", "properties": { "to": { @@ -171255,6 +171407,18 @@ "required": [ "to" ] + }, + "role_name": { + "description": "The role assigned to the collaborator.", + "type": "object", + "properties": { + "to": { + "type": "string" + } + }, + "required": [ + "to" + ] } } }, @@ -249801,7 +249965,7 @@ "type": "string" }, "commits": { - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.11/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.", + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.11/rest/commits) to fetch additional commits.", "type": "array", "items": { "title": "Commit", @@ -299632,7 +299796,7 @@ }, "workflow-run-status": { "name": "status", - "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`.", + "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`.", "in": "query", "required": false, "schema": { @@ -299886,6 +300050,17 @@ "type": "integer" } }, + "git-ref-only": { + "name": "ref", + "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, "invitation-id": { "name": "invitation_id", "description": "The unique identifier of the invitation.", diff --git a/cache/ghes-3.12.json b/cache/ghes-3.12.json index 113922b42..d6d6f947d 100644 --- a/cache/ghes-3.12.json +++ b/cache/ghes-3.12.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "14.0.0", + "version": "14.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -8773,7 +8773,7 @@ "/feeds": { "get": { "summary": "Get feeds", - "description": "GitHub Enterprise Server provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ "activity" ], @@ -12307,7 +12307,7 @@ "/organizations": { "get": { "summary": "List organizations", - "description": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "tags": [ "orgs" ], @@ -34440,11 +34440,14 @@ }, "status": { "type": "string", - "description": "The current status.", + "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -37099,6 +37102,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -37330,6 +37336,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -37389,6 +37398,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" }, @@ -37726,7 +37738,7 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "description": "Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.12/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.12/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -40667,6 +40679,616 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + "get": { + "summary": "List environment secrets", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#list-environment-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + "get": { + "summary": "Get an environment public key", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#get-an-environment-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + "get": { + "summary": "Get an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#get-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "put": { + "summary": "Create or update an environment secret", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#create-or-update-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#get-an-environment-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + }, + "required": [ + "encrypted_value", + "key_id" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#delete-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Default response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + "get": { + "summary": "List environment variables", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#list-environment-variables" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variables-per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-variable" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variables-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/create-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#create-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + }, + "required": [ + "name", + "value" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + "get": { + "summary": "Get an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#get-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-variable" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variable" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/update-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#update-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#delete-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", @@ -41039,6 +41661,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -41193,6 +41818,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -41247,6 +41875,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -41278,7 +41909,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -41304,6 +41935,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -41335,7 +41969,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -41356,6 +41990,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -41443,6 +42080,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -41459,7 +42099,7 @@ "/repos/{owner}/{repo}/git/refs/{ref}": { "patch": { "summary": "Update a reference", - "description": "", + "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.", "tags": [ "git" ], @@ -41476,15 +42116,7 @@ "$ref": "#/components/parameters/repo" }, { - "name": "ref", - "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.", - "in": "path", - "required": true, - "example": "heads/featureA", - "schema": { - "type": "string" - }, - "x-multi-segment": true + "$ref": "#/components/parameters/git-ref-only" } ], "requestBody": { @@ -41535,6 +42167,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -41549,7 +42184,7 @@ }, "delete": { "summary": "Delete a reference", - "description": "", + "description": "Deletes the provided reference.", "tags": [ "git" ], @@ -41566,13 +42201,16 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { "204": { "description": "Response" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -41707,6 +42345,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -41766,6 +42407,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -41903,6 +42547,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -41977,6 +42624,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -54490,587 +55140,7 @@ "x-octokit": {} } }, - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - "get": { - "summary": "List environment secrets", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-secrets", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#list-environment-secrets" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-secret" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - "get": { - "summary": "Get an environment public key", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#get-an-environment-public-key" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-public-key" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-public-key" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - "get": { - "summary": "Get an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#get-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-secret" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "put": { - "summary": "Create or update an environment secret", - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/create-or-update-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#create-or-update-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "encrypted_value": { - "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#get-an-environment-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "ID of the key you used to encrypt the secret." - } - }, - "required": [ - "encrypted_value", - "key_id" - ] - }, - "examples": { - "default": { - "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response when creating a secret", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#delete-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "204": { - "description": "Default response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables": { - "get": { - "summary": "List environment variables", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-variables", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#list-environment-variables" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variables-per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-variable" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variables-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "post": { - "summary": "Create an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/create-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#create-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - }, - "required": [ - "name", - "value" - ] - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - "get": { - "summary": "Get an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#get-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variable-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-variable" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variable" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "patch": { - "summary": "Update an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/update-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#update-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - } - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/actions/variables#delete-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, - "/scim/v2/Groups": { + "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", @@ -55109,6 +55179,9 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -55162,6 +55235,11 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/scim#provision-a-scim-enterprise-group" }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], "requestBody": { "required": true, "content": { @@ -55227,7 +55305,7 @@ "x-octokit": {} } }, - "/scim/v2/Groups/{scim_group_id}": { + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group.", @@ -55245,6 +55323,9 @@ }, { "$ref": "#/components/parameters/excluded-attributes" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -55304,6 +55385,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -55411,6 +55495,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -55528,6 +55615,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -55562,7 +55652,7 @@ "x-octokit": {} } }, - "/scim/v2/Users": { + "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.", @@ -55597,6 +55687,9 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -55650,6 +55743,11 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/scim#provision-a-scim-enterprise-user" }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], "requestBody": { "required": true, "content": { @@ -55715,7 +55813,7 @@ "x-octokit": {} } }, - "/scim/v2/Users/{scim_user_id}": { + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user.", @@ -55730,6 +55828,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -55789,6 +55890,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -55866,6 +55970,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -56001,6 +56108,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -64443,7 +64553,7 @@ "/users/{username}/hovercard": { "get": { "summary": "Get contextual information for a user", - "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.", + "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.", "tags": [ "users" ], @@ -103992,6 +104102,38 @@ } } }, + "repository-rule-params-thresholds": { + "title": "Thresholds", + "description": "This setting will not take effect unless at least one code scanning status check is enabled.", + "type": "object", + "properties": { + "code_scanning_alert_threshold": { + "type": "string", + "description": "Code scanning alert threshold", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "code_scanning_security_alert_threshold": { + "type": "string", + "description": "Code scanning security alert threshold.", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + } + }, + "required": [ + "code_scanning_alert_threshold", + "code_scanning_security_alert_threshold" + ] + }, "repository-rule": { "title": "Repository Rule", "type": "object", @@ -106277,7 +106419,9 @@ "queued", "in_progress", "completed", - "waiting" + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -108810,13 +108954,16 @@ "nullable": true }, "status": { - "description": "The phase of the lifecycle that the check is currently in.", + "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.", "example": "queued", "type": "string", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -109094,11 +109241,15 @@ }, "status": { "type": "string", + "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.", "example": "completed", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ], "nullable": true }, @@ -173448,6 +173599,7 @@ "type": "object", "properties": { "permission": { + "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.", "type": "object", "properties": { "to": { @@ -173462,6 +173614,18 @@ "required": [ "to" ] + }, + "role_name": { + "description": "The role assigned to the collaborator.", + "type": "object", + "properties": { + "to": { + "type": "string" + } + }, + "required": [ + "to" + ] } } }, @@ -252008,7 +252172,7 @@ "type": "string" }, "commits": { - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.12/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.", + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.12/rest/commits) to fetch additional commits.", "type": "array", "items": { "title": "Commit", @@ -302251,7 +302415,7 @@ }, "workflow-run-status": { "name": "status", - "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`.", + "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`.", "in": "query", "required": false, "schema": { @@ -302505,6 +302669,17 @@ "type": "integer" } }, + "git-ref-only": { + "name": "ref", + "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, "invitation-id": { "name": "invitation_id", "description": "The unique identifier of the invitation.", diff --git a/cache/ghes-3.8.json b/cache/ghes-3.8.json index 6a7b75855..6dab0c6a0 100644 --- a/cache/ghes-3.8.json +++ b/cache/ghes-3.8.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "14.0.0", + "version": "14.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -8344,7 +8344,7 @@ "/feeds": { "get": { "summary": "Get feeds", - "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.8/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.8/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "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.8/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.8/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.8/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ "activity" ], @@ -10863,7 +10863,7 @@ "/organizations": { "get": { "summary": "List organizations", - "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.8/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "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.8/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "tags": [ "orgs" ], @@ -30198,11 +30198,14 @@ }, "status": { "type": "string", - "description": "The current status.", + "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -32708,6 +32711,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -32939,6 +32945,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -32998,6 +33007,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" }, @@ -33335,7 +33347,7 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "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.8/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.8/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.8/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. |", + "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.8/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.8/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.8/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. |", "tags": [ "repos" ], @@ -35886,6 +35898,616 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + "get": { + "summary": "List environment secrets", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#list-environment-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + "get": { + "summary": "Get an environment public key", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#get-an-environment-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + "get": { + "summary": "Get an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#get-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "put": { + "summary": "Create or update an environment secret", + "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.8/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.", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#create-or-update-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "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.8/rest/actions/secrets#get-an-environment-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + }, + "required": [ + "encrypted_value", + "key_id" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#delete-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Default response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + "get": { + "summary": "List environment variables", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#list-environment-variables" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variables-per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-variable" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variables-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/create-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#create-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + }, + "required": [ + "name", + "value" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + "get": { + "summary": "Get an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#get-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-variable" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variable" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/update-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#update-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#delete-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", @@ -36258,6 +36880,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -36412,6 +37037,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -36466,6 +37094,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -36497,7 +37128,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -36523,6 +37154,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -36554,7 +37188,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -36575,6 +37209,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -36662,6 +37299,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -36678,7 +37318,7 @@ "/repos/{owner}/{repo}/git/refs/{ref}": { "patch": { "summary": "Update a reference", - "description": "", + "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.", "tags": [ "git" ], @@ -36695,15 +37335,7 @@ "$ref": "#/components/parameters/repo" }, { - "name": "ref", - "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.", - "in": "path", - "required": true, - "example": "heads/featureA", - "schema": { - "type": "string" - }, - "x-multi-segment": true + "$ref": "#/components/parameters/git-ref-only" } ], "requestBody": { @@ -36754,6 +37386,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -36768,7 +37403,7 @@ }, "delete": { "summary": "Delete a reference", - "description": "", + "description": "Deletes the provided reference.", "tags": [ "git" ], @@ -36785,13 +37420,16 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { "204": { "description": "Response" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -36926,6 +37564,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -36985,6 +37626,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -37122,6 +37766,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -37196,6 +37843,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -48950,587 +49600,7 @@ "x-octokit": {} } }, - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - "get": { - "summary": "List environment secrets", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-secrets", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#list-environment-secrets" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-secret" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - "get": { - "summary": "Get an environment public key", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#get-an-environment-public-key" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-public-key" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-public-key" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - "get": { - "summary": "Get an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#get-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-secret" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "put": { - "summary": "Create or update an environment secret", - "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.8/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.", - "tags": [ - "actions" - ], - "operationId": "actions/create-or-update-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#create-or-update-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "encrypted_value": { - "type": "string", - "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.8/rest/actions/secrets#get-an-environment-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "ID of the key you used to encrypt the secret." - } - }, - "required": [ - "encrypted_value", - "key_id" - ] - }, - "examples": { - "default": { - "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response when creating a secret", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#delete-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "204": { - "description": "Default response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables": { - "get": { - "summary": "List environment variables", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-variables", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#list-environment-variables" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variables-per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-variable" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variables-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "post": { - "summary": "Create an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/create-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#create-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - }, - "required": [ - "name", - "value" - ] - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - "get": { - "summary": "Get an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#get-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variable-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-variable" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variable" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "patch": { - "summary": "Update an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/update-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#update-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - } - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#delete-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, - "/scim/v2/Groups": { + "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", "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.", @@ -49569,6 +49639,9 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -49622,6 +49695,11 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/scim#provision-a-scim-enterprise-group" }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], "requestBody": { "required": true, "content": { @@ -49687,7 +49765,7 @@ "x-octokit": {} } }, - "/scim/v2/Groups/{scim_group_id}": { + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", "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.", @@ -49705,6 +49783,9 @@ }, { "$ref": "#/components/parameters/excluded-attributes" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -49764,6 +49845,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -49871,6 +49955,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -49988,6 +50075,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -50022,7 +50112,7 @@ "x-octokit": {} } }, - "/scim/v2/Users": { + "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", "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.", @@ -50057,6 +50147,9 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -50110,6 +50203,11 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/scim#provision-a-scim-enterprise-user" }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], "requestBody": { "required": true, "content": { @@ -50175,7 +50273,7 @@ "x-octokit": {} } }, - "/scim/v2/Users/{scim_user_id}": { + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", "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.", @@ -50190,6 +50288,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -50249,6 +50350,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -50326,6 +50430,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -50461,6 +50568,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -58117,7 +58227,7 @@ "/users/{username}/hovercard": { "get": { "summary": "Get contextual information for a user", - "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.", + "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.", "tags": [ "users" ], @@ -94137,7 +94247,9 @@ "queued", "in_progress", "completed", - "waiting" + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -96535,13 +96647,16 @@ "nullable": true }, "status": { - "description": "The phase of the lifecycle that the check is currently in.", + "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.", "example": "queued", "type": "string", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -96819,11 +96934,15 @@ }, "status": { "type": "string", + "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.", "example": "completed", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ], "nullable": true }, @@ -160086,6 +160205,7 @@ "type": "object", "properties": { "permission": { + "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.", "type": "object", "properties": { "to": { @@ -160100,6 +160220,18 @@ "required": [ "to" ] + }, + "role_name": { + "description": "The role assigned to the collaborator.", + "type": "object", + "properties": { + "to": { + "type": "string" + } + }, + "required": [ + "to" + ] } } }, @@ -238286,7 +238418,7 @@ "type": "string" }, "commits": { - "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.8/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.", + "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.8/rest/commits) to fetch additional commits.", "type": "array", "items": { "title": "Commit", @@ -286199,7 +286331,7 @@ }, "workflow-run-status": { "name": "status", - "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`.", + "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`.", "in": "query", "required": false, "schema": { @@ -286444,6 +286576,17 @@ "type": "integer" } }, + "git-ref-only": { + "name": "ref", + "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, "invitation-id": { "name": "invitation_id", "description": "The unique identifier of the invitation.", diff --git a/cache/ghes-3.9.json b/cache/ghes-3.9.json index c8e461b47..482a16ade 100644 --- a/cache/ghes-3.9.json +++ b/cache/ghes-3.9.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "14.0.0", + "version": "14.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -8365,7 +8365,7 @@ "/feeds": { "get": { "summary": "Get feeds", - "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.", + "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.", "tags": [ "activity" ], @@ -11085,7 +11085,7 @@ "/organizations": { "get": { "summary": "List organizations", - "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.", + "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.", "tags": [ "orgs" ], @@ -31437,11 +31437,14 @@ }, "status": { "type": "string", - "description": "The current status.", + "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -34088,6 +34091,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -34319,6 +34325,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -34378,6 +34387,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" }, @@ -34715,7 +34727,7 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "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. |", + "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. |", "tags": [ "repos" ], @@ -37322,6 +37334,616 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + "get": { + "summary": "List environment secrets", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-environment-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + "get": { + "summary": "Get an environment public key", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + "get": { + "summary": "Get an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "put": { + "summary": "Create or update an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "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.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + }, + "required": [ + "encrypted_value", + "key_id" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment secret", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#delete-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Default response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + "get": { + "summary": "List environment variables", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#list-environment-variables" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variables-per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-variable" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variables-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/create-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#create-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + }, + "required": [ + "name", + "value" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + "get": { + "summary": "Get an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#get-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-variable" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variable" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/update-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#update-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an environment variable", + "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.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#delete-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", @@ -37694,6 +38316,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -37848,6 +38473,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -37902,6 +38530,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -37933,7 +38564,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -37959,6 +38590,9 @@ "$ref": "#/components/headers/link" } } + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -37990,7 +38624,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { @@ -38011,6 +38645,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -38098,6 +38735,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -38114,7 +38754,7 @@ "/repos/{owner}/{repo}/git/refs/{ref}": { "patch": { "summary": "Update a reference", - "description": "", + "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.", "tags": [ "git" ], @@ -38131,15 +38771,7 @@ "$ref": "#/components/parameters/repo" }, { - "name": "ref", - "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.", - "in": "path", - "required": true, - "example": "heads/featureA", - "schema": { - "type": "string" - }, - "x-multi-segment": true + "$ref": "#/components/parameters/git-ref-only" } ], "requestBody": { @@ -38190,6 +38822,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -38204,7 +38839,7 @@ }, "delete": { "summary": "Delete a reference", - "description": "", + "description": "Deletes the provided reference.", "tags": [ "git" ], @@ -38221,13 +38856,16 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/commit-ref" + "$ref": "#/components/parameters/git-ref-only" } ], "responses": { "204": { "description": "Response" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -38362,6 +39000,9 @@ } } }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -38421,6 +39062,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { @@ -38558,6 +39202,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -38632,6 +39279,9 @@ "404": { "$ref": "#/components/responses/not_found" }, + "409": { + "$ref": "#/components/responses/conflict" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -50495,587 +51145,7 @@ "x-octokit": {} } }, - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - "get": { - "summary": "List environment secrets", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-secrets", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-environment-secrets" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-secret" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - "get": { - "summary": "Get an environment public key", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-public-key" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-public-key" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-public-key" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - "get": { - "summary": "Get an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-secret" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-secret" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "put": { - "summary": "Create or update an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/create-or-update-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "encrypted_value": { - "type": "string", - "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.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "ID of the key you used to encrypt the secret." - } - }, - "required": [ - "encrypted_value", - "key_id" - ] - }, - "examples": { - "default": { - "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response when creating a secret", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment secret", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#delete-an-environment-secret" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "204": { - "description": "Default response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables": { - "get": { - "summary": "List environment variables", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/list-environment-variables", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#list-environment-variables" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variables-per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/actions-variable" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variables-paginated" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "post": { - "summary": "Create an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/create-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#create-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - }, - "required": [ - "name", - "value" - ] - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/empty-object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - "get": { - "summary": "Get an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/get-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#get-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/environment-name" - }, - { - "$ref": "#/components/parameters/variable-name" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-variable" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-variable" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "patch": { - "summary": "Update an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/update-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#update-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - } - } - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete an environment variable", - "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.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-environment-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#delete-an-environment-variable" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/variable-name" - }, - { - "$ref": "#/components/parameters/environment-name" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - }, - "x-octokit": {} - } - }, - "/scim/v2/Groups": { + "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", "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 +51184,9 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -51167,6 +51240,11 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#provision-a-scim-enterprise-group" }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], "requestBody": { "required": true, "content": { @@ -51232,7 +51310,7 @@ "x-octokit": {} } }, - "/scim/v2/Groups/{scim_group_id}": { + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", "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 +51328,9 @@ }, { "$ref": "#/components/parameters/excluded-attributes" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -51309,6 +51390,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -51416,6 +51500,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -51533,6 +51620,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-group-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -51567,7 +51657,7 @@ "x-octokit": {} } }, - "/scim/v2/Users": { + "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", "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 +51692,9 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -51655,6 +51748,11 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#provision-a-scim-enterprise-user" }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], "requestBody": { "required": true, "content": { @@ -51720,7 +51818,7 @@ "x-octokit": {} } }, - "/scim/v2/Users/{scim_user_id}": { + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", "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 +51833,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -51794,6 +51895,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -51871,6 +51975,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "requestBody": { @@ -52006,6 +52113,9 @@ "parameters": [ { "$ref": "#/components/parameters/scim-user-id" + }, + { + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -60436,7 +60546,7 @@ "/users/{username}/hovercard": { "get": { "summary": "Get contextual information for a user", - "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.", + "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.", "tags": [ "users" ], @@ -98628,7 +98738,9 @@ "queued", "in_progress", "completed", - "waiting" + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -101033,13 +101145,16 @@ "nullable": true }, "status": { - "description": "The phase of the lifecycle that the check is currently in.", + "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.", "example": "queued", "type": "string", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ] }, "conclusion": { @@ -101317,11 +101432,15 @@ }, "status": { "type": "string", + "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.", "example": "completed", "enum": [ "queued", "in_progress", - "completed" + "completed", + "waiting", + "requested", + "pending" ], "nullable": true }, @@ -165006,6 +165125,7 @@ "type": "object", "properties": { "permission": { + "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.", "type": "object", "properties": { "to": { @@ -165020,6 +165140,18 @@ "required": [ "to" ] + }, + "role_name": { + "description": "The role assigned to the collaborator.", + "type": "object", + "properties": { + "to": { + "type": "string" + } + }, + "required": [ + "to" + ] } } }, @@ -243410,7 +243542,7 @@ "type": "string" }, "commits": { - "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.", + "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.", "type": "array", "items": { "title": "Commit", @@ -292112,7 +292244,7 @@ }, "workflow-run-status": { "name": "status", - "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`.", + "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`.", "in": "query", "required": false, "schema": { @@ -292357,6 +292489,17 @@ "type": "integer" } }, + "git-ref-only": { + "name": "ref", + "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, "invitation-id": { "name": "invitation_id", "description": "The unique identifier of the invitation.", diff --git a/cache/github.ae.json b/cache/github.ae.json index 63050fc11..c5fc4b18f 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "14.0.0", + "version": "14.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { diff --git a/packages/openapi-types-ghec/package.json b/packages/openapi-types-ghec/package.json index f7f1c0027..8db4b95d8 100644 --- a/packages/openapi-types-ghec/package.json +++ b/packages/openapi-types-ghec/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "14.0.0" + "openapi-version": "14.1.0" } } diff --git a/packages/openapi-types-ghec/types.d.ts b/packages/openapi-types-ghec/types.d.ts index 3987eefef..134179b64 100644 --- a/packages/openapi-types-ghec/types.d.ts +++ b/packages/openapi-types-ghec/types.d.ts @@ -781,7 +781,7 @@ export interface paths { "/feeds": { /** * Get feeds - * @description GitHub Enterprise Cloud provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + * @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. * * * **Timeline**: The GitHub Enterprise Cloud global public timeline * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." @@ -791,6 +791,8 @@ export interface paths { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud. * + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; @@ -1136,7 +1138,7 @@ export interface paths { "/organizations": { /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub Enterprise Cloud. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -5813,7 +5815,7 @@ export interface paths { "/repos/{owner}/{repo}/compare/{basehead}": { /** * Compare two commits - * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This 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. * @@ -6266,6 +6268,109 @@ export interface paths { */ delete: operations["repos/disable-deployment-protection-rule"]; }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-secrets"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-public-key"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-secret"]; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/create-or-update-environment-secret"]; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-secret"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-variables"]; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["actions/create-environment-variable"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-variable"]; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-variable"]; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + patch: operations["actions/update-environment-variable"]; + }; "/repos/{owner}/{repo}/events": { /** * List repository events @@ -6408,9 +6513,15 @@ export interface paths { post: operations["git/create-ref"]; }; "/repos/{owner}/{repo}/git/refs/{ref}": { - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ delete: operations["git/delete-ref"]; - /** Update a reference */ + /** + * Update a reference + * @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. + */ patch: operations["git/update-ref"]; }; "/repos/{owner}/{repo}/git/tags": { @@ -7281,6 +7392,11 @@ export interface paths { get: operations["repos/get-pages-health-check"]; }; "/repos/{owner}/{repo}/private-vulnerability-reporting": { + /** + * Check if private vulnerability reporting is enabled for a repository + * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + */ + get: operations["repos/check-private-vulnerability-reporting"]; /** * Enable private vulnerability reporting for a repository * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." @@ -8277,110 +8393,7 @@ export interface paths { */ get: operations["repos/list-public"]; }; - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-secrets"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-public-key"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-secret"]; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - put: operations["actions/create-or-update-environment-secret"]; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-secret"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables": { - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-variables"]; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - post: operations["actions/create-environment-variable"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-variable"]; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-variable"]; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - patch: operations["actions/update-environment-variable"]; - }; - "/scim/v2/Groups": { + "/scim/v2/enterprises/{enterprise}/Groups": { /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications. @@ -8402,7 +8415,7 @@ export interface paths { */ post: operations["enterprise-admin/provision-enterprise-group"]; }; - "/scim/v2/Groups/{scim_group_id}": { + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { /** * Get SCIM provisioning information for an enterprise group * @description **Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications. @@ -8444,7 +8457,7 @@ export interface paths { */ patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; }; - "/scim/v2/Users": { + "/scim/v2/enterprises/{enterprise}/Users": { /** * List SCIM provisioned identities for an enterprise * @description **Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications. @@ -8466,7 +8479,7 @@ export interface paths { */ post: operations["enterprise-admin/provision-enterprise-user"]; }; - "/scim/v2/Users/{scim_user_id}": { + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { /** * Get SCIM provisioning information for an enterprise user * @description **Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications. @@ -9957,12 +9970,7 @@ export interface paths { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -17622,6 +17630,31 @@ export interface components { workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; }; + /** + * Thresholds + * @description This setting will not take effect unless at least one code scanning status check is enabled. + */ + "repository-rule-params-thresholds": { + /** + * @description Code scanning alert threshold + * @enum {string} + */ + code_scanning_alert_threshold: + | "none" + | "errors" + | "errors_and_warnings" + | "all"; + /** + * @description Code scanning security alert threshold. + * @enum {string} + */ + code_scanning_security_alert_threshold: + | "none" + | "critical" + | "high_or_higher" + | "medium_or_higher" + | "all"; + }; /** * Repository Rule * @description A repository rule. @@ -19007,7 +19040,13 @@ export interface components { * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description The outcome of the job. * @example success @@ -20377,11 +20416,17 @@ export interface components { /** @example https://example.com */ details_url: string | null; /** - * @description The phase of the lifecycle that the check is currently in. + * @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. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @example neutral * @enum {string|null} @@ -20520,10 +20565,18 @@ export interface components { */ head_sha: string; /** + * @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. * @example completed * @enum {string|null} */ - status: "queued" | "in_progress" | "completed" | null; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending" + | null; /** * @example neutral * @enum {string|null} @@ -30358,7 +30411,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: unknown; + dismissed_by: Record | null; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -31574,7 +31627,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -31961,7 +32014,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -32355,7 +32408,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -34593,7 +34646,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: unknown; + license?: Record | null; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -35639,7 +35692,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -35666,10 +35719,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -36320,7 +36373,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -36347,10 +36400,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -37010,7 +37063,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -37037,10 +37090,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -38088,8 +38141,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -38099,13 +38152,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -39102,8 +39155,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -39113,7 +39166,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -39189,7 +39242,7 @@ export interface components { } | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -40790,8 +40843,8 @@ export interface components { | "too heated" | "spam" | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -40801,14 +40854,14 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: true; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -41325,8 +41378,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -41336,7 +41389,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -41412,7 +41465,7 @@ export interface components { }; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -43676,8 +43729,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -43687,13 +43740,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -46424,8 +46477,8 @@ export interface components { } | null; } & { active_lock_reason: unknown; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -46435,11 +46488,11 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: false; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; performed_via_github_app?: unknown; @@ -47485,10 +47538,20 @@ export interface components { /** @enum {string} */ action: "added"; changes?: { + /** + * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. + */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; }; + /** @description The role assigned to the collaborator. */ + role_name?: { + to: string; + }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; @@ -49023,8 +49086,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -49049,19 +49112,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: unknown; - bugs?: unknown; + author?: Record | null; + bugs?: Record | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: unknown; + dist?: Record | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: unknown; + repository?: Record | null; scripts?: Record; id?: string; node_version?: string; @@ -49074,7 +49137,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: unknown; + directories?: Record | null; os?: string[]; cpu?: string[]; readme?: string; @@ -81871,7 +81934,7 @@ export interface components { base_ref: string | null; /** @description The SHA of the most recent commit on `ref` before the push. */ before: string; - /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest//rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ + /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest//rest/commits) to fetch additional commits. */ commits: { /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ added?: string[]; @@ -82306,8 +82369,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -82579,7 +82642,7 @@ export interface components { updated_at: string; version: string; }; - registry: unknown; + registry: Record | null; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -83220,7 +83283,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -83415,7 +83478,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -83764,7 +83827,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -87526,7 +87589,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: unknown[]; + steps?: (Record | null)[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -88350,7 +88413,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -89064,7 +89127,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -89741,12 +89804,6 @@ export interface components { }; }; }; - /** @description Response if GitHub Advanced Security is not enabled for this repository */ - code_scanning_forbidden_read: { - content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; /** @description Forbidden Gist */ forbidden_gist: { content: { @@ -89799,6 +89856,12 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response if GitHub Advanced Security is not enabled for this repository */ + code_scanning_forbidden_read: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { content: { @@ -90185,7 +90248,7 @@ export interface components { "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-cloud@latest//actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: string; - /** @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`. */ + /** @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`. */ "workflow-run-status"?: | "completed" | "action_required" @@ -90254,6 +90317,11 @@ export interface components { "branch-policy-id": number; /** @description The unique identifier of the protection rule. */ "protection-rule-id": number; + /** + * @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. + * @example heads/feature-a + */ + "git-ref-only": string; /** @description A user ID. Only return users with an ID greater than this ID. */ "since-user"?: number; /** @description The number that identifies the issue. */ @@ -92952,7 +93020,6 @@ export interface operations { "application/json": components["schemas"]["advanced-security-active-committers"]; }; }; - 403: components["responses"]["code_scanning_forbidden_read"]; }; }; /** @@ -93054,7 +93121,7 @@ export interface operations { }; /** * Get feeds - * @description GitHub Enterprise Cloud provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + * @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. * * * **Timeline**: The GitHub Enterprise Cloud global public timeline * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." @@ -93064,6 +93131,8 @@ export interface operations { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud. * + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ "activity/get-feeds": { @@ -94321,7 +94390,7 @@ export interface operations { }; /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub Enterprise Cloud. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -96944,6 +97013,10 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + /** @description There is a problem with your account's associated payment method. */ + 422: { + content: never; + }; 500: components["responses"]["internal_error"]; }; }; @@ -101161,7 +101234,6 @@ export interface operations { "application/json": components["schemas"]["advanced-security-active-committers"]; }; }; - 403: components["responses"]["code_scanning_forbidden_read"]; }; }; /** @@ -107205,10 +107277,16 @@ export interface operations { */ started_at?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. @@ -109026,6 +109104,7 @@ export interface operations { "application/json": components["schemas"]["branch-short"][]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -109142,6 +109221,7 @@ export interface operations { "application/json": components["schemas"]["pull-request-simple"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -109205,6 +109285,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; 503: components["responses"]["service_unavailable"]; @@ -109389,7 +109470,7 @@ export interface operations { }; /** * Compare two commits - * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This 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. * @@ -110848,6 +110929,313 @@ export interface operations { }; }; }; + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-secrets": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; + }; + }; + }; + }; + }; + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-public-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + }; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-or-update-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key) endpoint. */ + encrypted_value: string; + /** @description ID of the key you used to encrypt the secret. */ + key_id: string; + }; + }; + }; + responses: { + /** @description Response when creating a secret */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + 204: { + content: never; + }; + }; + }; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Default response */ + 204: { + content: never; + }; + }; + }; + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-variables": { + parameters: { + query?: { + per_page?: components["parameters"]["variables-per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; + }; + }; + }; + }; + }; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name: string; + /** @description The value of the variable. */ + value: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + }; + }; + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + name: components["parameters"]["variable-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-variable"]; + }; + }; + }; + }; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/update-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name?: string; + /** @description The value of the variable. */ + value?: string; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; /** * List repository events * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -111005,6 +111393,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -111098,6 +111487,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -111152,6 +111542,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -111169,7 +111560,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -111182,6 +111573,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -111195,7 +111587,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -111206,6 +111598,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -111240,16 +111633,20 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ "git/delete-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -111257,20 +111654,20 @@ export interface operations { 204: { content: never; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Update a reference */ + /** + * Update a reference + * @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. + */ "git/update-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** - * @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. - * @example heads/featureA - */ - ref: string; + ref: components["parameters"]["git-ref-only"]; }; }; requestBody: { @@ -111293,6 +111690,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -111376,6 +111774,7 @@ export interface operations { "application/json": components["schemas"]["git-tag"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -111426,6 +111825,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -111494,6 +111894,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -111527,6 +111928,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -113763,6 +114165,9 @@ export interface operations { */ "licenses/get-for-repo": { parameters: { + query?: { + ref?: components["parameters"]["git-ref"]; + }; path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; @@ -114492,6 +114897,30 @@ export interface operations { }; }; }; + /** + * Check if private vulnerability reporting is enabled for a repository + * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + */ + "repos/check-private-vulnerability-reporting": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Private vulnerability reporting status */ + 200: { + content: { + "application/json": { + /** @description Whether or not private vulnerability reporting is enabled for the repository. */ + enabled: boolean; + }; + }; + }; + 422: components["responses"]["bad_request"]; + }; + }; /** * Enable private vulnerability reporting for a repository * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." @@ -117977,303 +118406,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-secrets": { - parameters: { - query?: { - per_page?: components["parameters"]["per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-public-key": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-or-update-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key) endpoint. */ - encrypted_value: string; - /** @description ID of the key you used to encrypt the secret. */ - key_id: string; - }; - }; - }; - responses: { - /** @description Response when creating a secret */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - 204: { - content: never; - }; - }; - }; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Default response */ - 204: { - content: never; - }; - }; - }; - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-variables": { - parameters: { - query?: { - per_page?: components["parameters"]["variables-per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - variables: components["schemas"]["actions-variable"][]; - }; - }; - }; - }; - }; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name: string; - /** @description The value of the variable. */ - value: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - }; - }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - name: components["parameters"]["variable-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-variable"]; - }; - }; - }; - }; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/update-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name?: string; - /** @description The value of the variable. */ - value?: string; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications. @@ -118292,6 +118424,9 @@ export interface operations { startIndex?: components["parameters"]["start-index"]; count?: components["parameters"]["count"]; }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; }; responses: { /** @description Success, either groups were found or not found */ @@ -118317,6 +118452,11 @@ export interface operations { * When members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user. */ "enterprise-admin/provision-enterprise-group": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; requestBody: { content: { "application/json": components["schemas"]["group"]; @@ -118351,6 +118491,7 @@ export interface operations { }; path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -118381,6 +118522,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -118415,6 +118557,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -118447,6 +118590,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -118491,6 +118635,9 @@ export interface operations { startIndex?: components["parameters"]["start-index"]; count?: components["parameters"]["count"]; }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; }; responses: { /** @description Success, either users were found or not found */ @@ -118516,6 +118663,11 @@ export interface operations { * SCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML. */ "enterprise-admin/provision-enterprise-user": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; requestBody: { content: { "application/json": components["schemas"]["user"]; @@ -118547,6 +118699,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -118579,6 +118732,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -118613,6 +118767,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -118656,6 +118811,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -123615,12 +123771,7 @@ export interface operations { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ diff --git a/packages/openapi-types-ghes-3.10/package.json b/packages/openapi-types-ghes-3.10/package.json index 91cb351b5..a224123e7 100644 --- a/packages/openapi-types-ghes-3.10/package.json +++ b/packages/openapi-types-ghes-3.10/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "14.0.0" + "openapi-version": "14.1.0" } } diff --git a/packages/openapi-types-ghes-3.10/types.d.ts b/packages/openapi-types-ghes-3.10/types.d.ts index 67cf43e58..5f90a4d33 100644 --- a/packages/openapi-types-ghes-3.10/types.d.ts +++ b/packages/openapi-types-ghes-3.10/types.d.ts @@ -989,7 +989,7 @@ export interface paths { "/feeds": { /** * Get feeds - * @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: + * @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. * * * **Timeline**: The GitHub Enterprise Server global public timeline * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." @@ -999,6 +999,8 @@ export interface paths { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * + * By 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.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; @@ -1310,7 +1312,7 @@ export interface paths { "/organizations": { /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub Enterprise Server. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -5031,7 +5033,7 @@ export interface paths { "/repos/{owner}/{repo}/compare/{basehead}": { /** * Compare two commits - * @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.10/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @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.10/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This 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. * @@ -5484,6 +5486,109 @@ export interface paths { */ delete: operations["repos/disable-deployment-protection-rule"]; }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-secrets"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-public-key"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-secret"]; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [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.10/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/create-or-update-environment-secret"]; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-secret"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-variables"]; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["actions/create-environment-variable"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-variable"]; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-variable"]; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + patch: operations["actions/update-environment-variable"]; + }; "/repos/{owner}/{repo}/events": { /** * List repository events @@ -5626,9 +5731,15 @@ export interface paths { post: operations["git/create-ref"]; }; "/repos/{owner}/{repo}/git/refs/{ref}": { - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ delete: operations["git/delete-ref"]; - /** Update a reference */ + /** + * Update a reference + * @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. + */ patch: operations["git/update-ref"]; }; "/repos/{owner}/{repo}/git/tags": { @@ -7156,110 +7267,7 @@ export interface paths { */ get: operations["repos/list-public"]; }; - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-secrets"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-public-key"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-secret"]; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [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.10/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - put: operations["actions/create-or-update-environment-secret"]; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-secret"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables": { - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-variables"]; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - post: operations["actions/create-environment-variable"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-variable"]; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-variable"]; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - patch: operations["actions/update-environment-variable"]; - }; - "/scim/v2/Groups": { + "/scim/v2/enterprises/{enterprise}/Groups": { /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -7279,7 +7287,7 @@ export interface paths { */ post: operations["enterprise-admin/provision-enterprise-group"]; }; - "/scim/v2/Groups/{scim_group_id}": { + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { /** * Get SCIM provisioning information for an enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -7315,7 +7323,7 @@ export interface paths { */ patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; }; - "/scim/v2/Users": { + "/scim/v2/enterprises/{enterprise}/Users": { /** * List SCIM provisioned identities for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -7337,7 +7345,7 @@ export interface paths { */ post: operations["enterprise-admin/provision-enterprise-user"]; }; - "/scim/v2/Users/{scim_user_id}": { + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { /** * Get SCIM provisioning information for an enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -8538,12 +8546,7 @@ export interface paths { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -15789,7 +15792,13 @@ export interface components { * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description The outcome of the job. * @example success @@ -17065,11 +17074,17 @@ export interface components { /** @example https://example.com */ details_url: string | null; /** - * @description The phase of the lifecycle that the check is currently in. + * @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. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @example neutral * @enum {string|null} @@ -17208,10 +17223,18 @@ export interface components { */ head_sha: string; /** + * @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. * @example completed * @enum {string|null} */ - status: "queued" | "in_progress" | "completed" | null; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending" + | null; /** * @example neutral * @enum {string|null} @@ -26157,7 +26180,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: unknown; + dismissed_by: Record | null; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -27304,7 +27327,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -27691,7 +27714,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -28085,7 +28108,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -30333,7 +30356,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: unknown; + license?: Record | null; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -31378,7 +31401,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -31405,10 +31428,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -32059,7 +32082,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -32086,10 +32109,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -32749,7 +32772,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -32776,10 +32799,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -33827,8 +33850,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -33838,13 +33861,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -34841,8 +34864,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -34852,7 +34875,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -34928,7 +34951,7 @@ export interface components { } | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -36529,8 +36552,8 @@ export interface components { | "too heated" | "spam" | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -36540,14 +36563,14 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: true; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -37064,8 +37087,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -37075,7 +37098,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -37151,7 +37174,7 @@ export interface components { }; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -39411,8 +39434,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -39422,13 +39445,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -42155,8 +42178,8 @@ export interface components { } | null; } & { active_lock_reason: unknown; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -42166,11 +42189,11 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: false; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; performed_via_github_app?: unknown; @@ -42794,67 +42817,77 @@ export interface components { /** @enum {string} */ action: "added"; changes?: { + /** + * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. + */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** member edited event */ - "webhook-member-edited": { - /** @enum {string} */ - action: "edited"; - /** @description The changes to the collaborator permissions */ - changes: { - old_permission?: { - /** @description The previous permissions of the collaborator if the action was edited. */ - from: string; - }; - permission?: { - from?: string | null; - to?: string | null; + /** @description The role assigned to the collaborator. */ + role_name?: { + to: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** User */ + member: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member edited event */ + "webhook-member-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the collaborator permissions */ + changes: { + old_permission?: { + /** @description The previous permissions of the collaborator if the action was edited. */ + from: string; + }; + permission?: { + from?: string | null; + to?: string | null; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -44215,8 +44248,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -44241,19 +44274,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: unknown; - bugs?: unknown; + author?: Record | null; + bugs?: Record | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: unknown; + dist?: Record | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: unknown; + repository?: Record | null; scripts?: Record; id?: string; node_version?: string; @@ -44266,7 +44299,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: unknown; + directories?: Record | null; os?: string[]; cpu?: string[]; readme?: string; @@ -74638,7 +74671,7 @@ export interface components { base_ref: string | null; /** @description The SHA of the most recent commit on `ref` before the push. */ before: string; - /** @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.10/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ + /** @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.10/rest/commits) to fetch additional commits. */ commits: { /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ added?: string[]; @@ -75069,8 +75102,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -75342,7 +75375,7 @@ export interface components { updated_at: string; version: string; }; - registry: unknown; + registry: Record | null; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -75983,7 +76016,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -76178,7 +76211,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -76527,7 +76560,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -80256,7 +80289,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: unknown[]; + steps?: (Record | null)[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -81080,7 +81113,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -81794,7 +81827,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -82867,7 +82900,7 @@ export interface components { "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.10/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: string; - /** @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`. */ + /** @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`. */ "workflow-run-status"?: | "completed" | "action_required" @@ -82936,6 +82969,11 @@ export interface components { "branch-policy-id": number; /** @description The unique identifier of the protection rule. */ "protection-rule-id": number; + /** + * @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. + * @example heads/feature-a + */ + "git-ref-only": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ @@ -86699,7 +86737,7 @@ export interface operations { }; /** * Get feeds - * @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: + * @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. * * * **Timeline**: The GitHub Enterprise Server global public timeline * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." @@ -86709,6 +86747,8 @@ export interface operations { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * + * By 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.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ "activity/get-feeds": { @@ -87915,7 +87955,7 @@ export interface operations { }; /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub Enterprise Server. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -98314,10 +98354,16 @@ export interface operations { */ started_at?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. @@ -99675,6 +99721,7 @@ export interface operations { "application/json": components["schemas"]["branch-short"][]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -99791,6 +99838,7 @@ export interface operations { "application/json": components["schemas"]["pull-request-simple"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -99854,6 +99902,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; 503: components["responses"]["service_unavailable"]; @@ -100008,7 +100057,7 @@ export interface operations { }; /** * Compare two commits - * @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.10/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @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.10/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This 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. * @@ -101466,6 +101515,313 @@ export interface operations { }; }; }; + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-secrets": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; + }; + }; + }; + }; + }; + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-public-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + }; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [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.10/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-or-update-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @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.10/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + encrypted_value: string; + /** @description ID of the key you used to encrypt the secret. */ + key_id: string; + }; + }; + }; + responses: { + /** @description Response when creating a secret */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + 204: { + content: never; + }; + }; + }; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Default response */ + 204: { + content: never; + }; + }; + }; + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-variables": { + parameters: { + query?: { + per_page?: components["parameters"]["variables-per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; + }; + }; + }; + }; + }; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name: string; + /** @description The value of the variable. */ + value: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + }; + }; + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + name: components["parameters"]["variable-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-variable"]; + }; + }; + }; + }; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/update-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name?: string; + /** @description The value of the variable. */ + value?: string; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; /** * List repository events * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -101623,6 +101979,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -101716,6 +102073,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -101770,6 +102128,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -101787,7 +102146,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -101800,6 +102159,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -101813,7 +102173,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -101824,6 +102184,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -101858,16 +102219,20 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ "git/delete-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -101875,20 +102240,20 @@ export interface operations { 204: { content: never; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Update a reference */ + /** + * Update a reference + * @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. + */ "git/update-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** - * @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. - * @example heads/featureA - */ - ref: string; + ref: components["parameters"]["git-ref-only"]; }; }; requestBody: { @@ -101911,6 +102276,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -101994,6 +102360,7 @@ export interface operations { "application/json": components["schemas"]["git-tag"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -102044,6 +102411,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -102112,6 +102480,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -102145,6 +102514,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -107527,303 +107897,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-secrets": { - parameters: { - query?: { - per_page?: components["parameters"]["per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-public-key": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [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.10/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-or-update-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @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.10/rest/actions/secrets#get-an-environment-public-key) endpoint. */ - encrypted_value: string; - /** @description ID of the key you used to encrypt the secret. */ - key_id: string; - }; - }; - }; - responses: { - /** @description Response when creating a secret */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - 204: { - content: never; - }; - }; - }; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Default response */ - 204: { - content: never; - }; - }; - }; - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-variables": { - parameters: { - query?: { - per_page?: components["parameters"]["variables-per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - variables: components["schemas"]["actions-variable"][]; - }; - }; - }; - }; - }; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name: string; - /** @description The value of the variable. */ - value: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - }; - }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - name: components["parameters"]["variable-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-variable"]; - }; - }; - }; - }; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/update-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name?: string; - /** @description The value of the variable. */ - value?: string; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -107841,6 +107914,9 @@ export interface operations { startIndex?: components["parameters"]["start-index"]; count?: components["parameters"]["count"]; }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; }; responses: { /** @description Success, either groups were found or not found */ @@ -107865,6 +107941,11 @@ export interface operations { * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. */ "enterprise-admin/provision-enterprise-group": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; requestBody: { content: { "application/json": components["schemas"]["group"]; @@ -107898,6 +107979,7 @@ export interface operations { }; path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -107927,6 +108009,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -107960,6 +108043,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -107989,6 +108073,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -108032,6 +108117,9 @@ export interface operations { startIndex?: components["parameters"]["start-index"]; count?: components["parameters"]["count"]; }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; }; responses: { /** @description Success, either users were found or not found */ @@ -108058,6 +108146,11 @@ export interface operations { * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. */ "enterprise-admin/provision-enterprise-user": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; requestBody: { content: { "application/json": components["schemas"]["user"]; @@ -108088,6 +108181,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -108119,6 +108213,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -108152,6 +108247,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -108193,6 +108289,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -112049,12 +112146,7 @@ export interface operations { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ diff --git a/packages/openapi-types-ghes-3.11/package.json b/packages/openapi-types-ghes-3.11/package.json index 5ef2a1734..472a750dd 100644 --- a/packages/openapi-types-ghes-3.11/package.json +++ b/packages/openapi-types-ghes-3.11/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "14.0.0" + "openapi-version": "14.1.0" } } diff --git a/packages/openapi-types-ghes-3.11/types.d.ts b/packages/openapi-types-ghes-3.11/types.d.ts index 2ed6cba70..85ebb0238 100644 --- a/packages/openapi-types-ghes-3.11/types.d.ts +++ b/packages/openapi-types-ghes-3.11/types.d.ts @@ -1005,7 +1005,7 @@ export interface paths { "/feeds": { /** * Get feeds - * @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: + * @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. * * * **Timeline**: The GitHub Enterprise Server global public timeline * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." @@ -1015,6 +1015,8 @@ export interface paths { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; @@ -1326,7 +1328,7 @@ export interface paths { "/organizations": { /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub Enterprise Server. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -5086,7 +5088,7 @@ export interface paths { "/repos/{owner}/{repo}/compare/{basehead}": { /** * Compare two commits - * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This 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. * @@ -5539,6 +5541,109 @@ export interface paths { */ delete: operations["repos/disable-deployment-protection-rule"]; }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-secrets"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-public-key"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-secret"]; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/create-or-update-environment-secret"]; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-secret"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-variables"]; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["actions/create-environment-variable"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-variable"]; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-variable"]; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + patch: operations["actions/update-environment-variable"]; + }; "/repos/{owner}/{repo}/events": { /** * List repository events @@ -5681,9 +5786,15 @@ export interface paths { post: operations["git/create-ref"]; }; "/repos/{owner}/{repo}/git/refs/{ref}": { - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ delete: operations["git/delete-ref"]; - /** Update a reference */ + /** + * Update a reference + * @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. + */ patch: operations["git/update-ref"]; }; "/repos/{owner}/{repo}/git/tags": { @@ -7250,110 +7361,7 @@ export interface paths { */ get: operations["repos/list-public"]; }; - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-secrets"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-public-key"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-secret"]; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - put: operations["actions/create-or-update-environment-secret"]; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-secret"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables": { - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-variables"]; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - post: operations["actions/create-environment-variable"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-variable"]; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-variable"]; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - patch: operations["actions/update-environment-variable"]; - }; - "/scim/v2/Groups": { + "/scim/v2/enterprises/{enterprise}/Groups": { /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -7373,7 +7381,7 @@ export interface paths { */ post: operations["enterprise-admin/provision-enterprise-group"]; }; - "/scim/v2/Groups/{scim_group_id}": { + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { /** * Get SCIM provisioning information for an enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -7409,7 +7417,7 @@ export interface paths { */ patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; }; - "/scim/v2/Users": { + "/scim/v2/enterprises/{enterprise}/Users": { /** * List SCIM provisioned identities for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -7431,7 +7439,7 @@ export interface paths { */ post: operations["enterprise-admin/provision-enterprise-user"]; }; - "/scim/v2/Users/{scim_user_id}": { + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { /** * Get SCIM provisioning information for an enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -8632,12 +8640,7 @@ export interface paths { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -15218,6 +15221,31 @@ export interface components { workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; }; + /** + * Thresholds + * @description This setting will not take effect unless at least one code scanning status check is enabled. + */ + "repository-rule-params-thresholds": { + /** + * @description Code scanning alert threshold + * @enum {string} + */ + code_scanning_alert_threshold: + | "none" + | "errors" + | "errors_and_warnings" + | "all"; + /** + * @description Code scanning security alert threshold. + * @enum {string} + */ + code_scanning_security_alert_threshold: + | "none" + | "critical" + | "high_or_higher" + | "medium_or_higher" + | "all"; + }; /** * Repository Rule * @description A repository rule. @@ -16428,7 +16456,13 @@ export interface components { * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description The outcome of the job. * @example success @@ -17748,11 +17782,17 @@ export interface components { /** @example https://example.com */ details_url: string | null; /** - * @description The phase of the lifecycle that the check is currently in. + * @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. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @example neutral * @enum {string|null} @@ -17891,10 +17931,18 @@ export interface components { */ head_sha: string; /** + * @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. * @example completed * @enum {string|null} */ - status: "queued" | "in_progress" | "completed" | null; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending" + | null; /** * @example neutral * @enum {string|null} @@ -26926,7 +26974,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: unknown; + dismissed_by: Record | null; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -28073,7 +28121,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -28460,7 +28508,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -28854,7 +28902,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -31102,7 +31150,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: unknown; + license?: Record | null; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -32148,7 +32196,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -32175,10 +32223,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -32829,7 +32877,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -32856,10 +32904,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -33519,7 +33567,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -33546,10 +33594,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -34597,8 +34645,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -34608,13 +34656,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -35611,8 +35659,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -35622,7 +35670,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -35698,7 +35746,7 @@ export interface components { } | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -37299,8 +37347,8 @@ export interface components { | "too heated" | "spam" | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -37310,14 +37358,14 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: true; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -37834,8 +37882,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -37845,7 +37893,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -37921,7 +37969,7 @@ export interface components { }; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -40181,8 +40229,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -40192,13 +40240,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -42925,8 +42973,8 @@ export interface components { } | null; } & { active_lock_reason: unknown; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -42936,11 +42984,11 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: false; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; performed_via_github_app?: unknown; @@ -43564,67 +43612,77 @@ export interface components { /** @enum {string} */ action: "added"; changes?: { + /** + * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. + */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** member edited event */ - "webhook-member-edited": { - /** @enum {string} */ - action: "edited"; - /** @description The changes to the collaborator permissions */ - changes: { - old_permission?: { - /** @description The previous permissions of the collaborator if the action was edited. */ - from: string; - }; - permission?: { - from?: string | null; - to?: string | null; + /** @description The role assigned to the collaborator. */ + role_name?: { + to: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** User */ + member: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member edited event */ + "webhook-member-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the collaborator permissions */ + changes: { + old_permission?: { + /** @description The previous permissions of the collaborator if the action was edited. */ + from: string; + }; + permission?: { + from?: string | null; + to?: string | null; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -44985,8 +45043,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -45011,19 +45069,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: unknown; - bugs?: unknown; + author?: Record | null; + bugs?: Record | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: unknown; + dist?: Record | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: unknown; + repository?: Record | null; scripts?: Record; id?: string; node_version?: string; @@ -45036,7 +45094,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: unknown; + directories?: Record | null; os?: string[]; cpu?: string[]; readme?: string; @@ -75408,7 +75466,7 @@ export interface components { base_ref: string | null; /** @description The SHA of the most recent commit on `ref` before the push. */ before: string; - /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.11/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ + /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.11/rest/commits) to fetch additional commits. */ commits: { /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ added?: string[]; @@ -75839,8 +75897,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -76112,7 +76170,7 @@ export interface components { updated_at: string; version: string; }; - registry: unknown; + registry: Record | null; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -76753,7 +76811,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -76948,7 +77006,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -77297,7 +77355,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -81106,7 +81164,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: unknown[]; + steps?: (Record | null)[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -81930,7 +81988,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -82644,7 +82702,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -83719,7 +83777,7 @@ export interface components { "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.11/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: string; - /** @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`. */ + /** @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`. */ "workflow-run-status"?: | "completed" | "action_required" @@ -83788,6 +83846,11 @@ export interface components { "branch-policy-id": number; /** @description The unique identifier of the protection rule. */ "protection-rule-id": number; + /** + * @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. + * @example heads/feature-a + */ + "git-ref-only": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ @@ -87662,7 +87725,7 @@ export interface operations { }; /** * Get feeds - * @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: + * @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. * * * **Timeline**: The GitHub Enterprise Server global public timeline * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." @@ -87672,6 +87735,8 @@ export interface operations { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ "activity/get-feeds": { @@ -88878,7 +88943,7 @@ export interface operations { }; /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub Enterprise Server. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -99509,10 +99574,16 @@ export interface operations { */ started_at?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. @@ -100870,6 +100941,7 @@ export interface operations { "application/json": components["schemas"]["branch-short"][]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -100986,6 +101058,7 @@ export interface operations { "application/json": components["schemas"]["pull-request-simple"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -101049,6 +101122,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; 503: components["responses"]["service_unavailable"]; @@ -101203,7 +101277,7 @@ export interface operations { }; /** * Compare two commits - * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This 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. * @@ -102662,6 +102736,313 @@ export interface operations { }; }; }; + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-secrets": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; + }; + }; + }; + }; + }; + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-public-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + }; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-or-update-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + encrypted_value: string; + /** @description ID of the key you used to encrypt the secret. */ + key_id: string; + }; + }; + }; + responses: { + /** @description Response when creating a secret */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + 204: { + content: never; + }; + }; + }; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Default response */ + 204: { + content: never; + }; + }; + }; + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-variables": { + parameters: { + query?: { + per_page?: components["parameters"]["variables-per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; + }; + }; + }; + }; + }; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name: string; + /** @description The value of the variable. */ + value: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + }; + }; + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + name: components["parameters"]["variable-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-variable"]; + }; + }; + }; + }; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/update-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name?: string; + /** @description The value of the variable. */ + value?: string; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; /** * List repository events * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -102819,6 +103200,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -102912,6 +103294,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -102966,6 +103349,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -102983,7 +103367,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -102996,6 +103380,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -103009,7 +103394,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -103020,6 +103405,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -103054,16 +103440,20 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ "git/delete-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -103071,20 +103461,20 @@ export interface operations { 204: { content: never; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Update a reference */ + /** + * Update a reference + * @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. + */ "git/update-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** - * @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. - * @example heads/featureA - */ - ref: string; + ref: components["parameters"]["git-ref-only"]; }; }; requestBody: { @@ -103107,6 +103497,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -103190,6 +103581,7 @@ export interface operations { "application/json": components["schemas"]["git-tag"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -103240,6 +103632,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -103308,6 +103701,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -103341,6 +103735,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -108915,303 +109310,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-secrets": { - parameters: { - query?: { - per_page?: components["parameters"]["per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-public-key": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-or-update-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-public-key) endpoint. */ - encrypted_value: string; - /** @description ID of the key you used to encrypt the secret. */ - key_id: string; - }; - }; - }; - responses: { - /** @description Response when creating a secret */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - 204: { - content: never; - }; - }; - }; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Default response */ - 204: { - content: never; - }; - }; - }; - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-variables": { - parameters: { - query?: { - per_page?: components["parameters"]["variables-per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - variables: components["schemas"]["actions-variable"][]; - }; - }; - }; - }; - }; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name: string; - /** @description The value of the variable. */ - value: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - }; - }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - name: components["parameters"]["variable-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-variable"]; - }; - }; - }; - }; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/update-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name?: string; - /** @description The value of the variable. */ - value?: string; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -109229,6 +109327,9 @@ export interface operations { startIndex?: components["parameters"]["start-index"]; count?: components["parameters"]["count"]; }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; }; responses: { /** @description Success, either groups were found or not found */ @@ -109253,6 +109354,11 @@ export interface operations { * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. */ "enterprise-admin/provision-enterprise-group": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; requestBody: { content: { "application/json": components["schemas"]["group"]; @@ -109286,6 +109392,7 @@ export interface operations { }; path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -109315,6 +109422,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -109348,6 +109456,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -109377,6 +109486,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -109420,6 +109530,9 @@ export interface operations { startIndex?: components["parameters"]["start-index"]; count?: components["parameters"]["count"]; }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; }; responses: { /** @description Success, either users were found or not found */ @@ -109446,6 +109559,11 @@ export interface operations { * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. */ "enterprise-admin/provision-enterprise-user": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; requestBody: { content: { "application/json": components["schemas"]["user"]; @@ -109476,6 +109594,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -109507,6 +109626,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -109540,6 +109660,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -109581,6 +109702,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -113437,12 +113559,7 @@ export interface operations { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ diff --git a/packages/openapi-types-ghes-3.12/package.json b/packages/openapi-types-ghes-3.12/package.json index 790847a47..35fb35ae0 100644 --- a/packages/openapi-types-ghes-3.12/package.json +++ b/packages/openapi-types-ghes-3.12/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "14.0.0" + "openapi-version": "14.1.0" } } diff --git a/packages/openapi-types-ghes-3.12/types.d.ts b/packages/openapi-types-ghes-3.12/types.d.ts index ed91c205b..e81431e32 100644 --- a/packages/openapi-types-ghes-3.12/types.d.ts +++ b/packages/openapi-types-ghes-3.12/types.d.ts @@ -1005,7 +1005,7 @@ export interface paths { "/feeds": { /** * Get feeds - * @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: + * @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. * * * **Timeline**: The GitHub Enterprise Server global public timeline * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." @@ -1015,6 +1015,8 @@ export interface paths { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; @@ -1399,7 +1401,7 @@ export interface paths { "/organizations": { /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub Enterprise Server. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -5185,7 +5187,7 @@ export interface paths { "/repos/{owner}/{repo}/compare/{basehead}": { /** * Compare two commits - * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.12/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.12/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This 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. * @@ -5638,6 +5640,109 @@ export interface paths { */ delete: operations["repos/disable-deployment-protection-rule"]; }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-secrets"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-public-key"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-secret"]; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/create-or-update-environment-secret"]; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-secret"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-variables"]; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["actions/create-environment-variable"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-variable"]; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-variable"]; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + patch: operations["actions/update-environment-variable"]; + }; "/repos/{owner}/{repo}/events": { /** * List repository events @@ -5780,9 +5885,15 @@ export interface paths { post: operations["git/create-ref"]; }; "/repos/{owner}/{repo}/git/refs/{ref}": { - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ delete: operations["git/delete-ref"]; - /** Update a reference */ + /** + * Update a reference + * @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. + */ patch: operations["git/update-ref"]; }; "/repos/{owner}/{repo}/git/tags": { @@ -7365,110 +7476,7 @@ export interface paths { */ get: operations["repos/list-public"]; }; - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-secrets"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-public-key"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-secret"]; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - put: operations["actions/create-or-update-environment-secret"]; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-secret"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables": { - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-variables"]; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - post: operations["actions/create-environment-variable"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-variable"]; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-variable"]; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - patch: operations["actions/update-environment-variable"]; - }; - "/scim/v2/Groups": { + "/scim/v2/enterprises/{enterprise}/Groups": { /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -7488,7 +7496,7 @@ export interface paths { */ post: operations["enterprise-admin/provision-enterprise-group"]; }; - "/scim/v2/Groups/{scim_group_id}": { + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { /** * Get SCIM provisioning information for an enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -7524,7 +7532,7 @@ export interface paths { */ patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; }; - "/scim/v2/Users": { + "/scim/v2/enterprises/{enterprise}/Users": { /** * List SCIM provisioned identities for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -7546,7 +7554,7 @@ export interface paths { */ post: operations["enterprise-admin/provision-enterprise-user"]; }; - "/scim/v2/Users/{scim_user_id}": { + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { /** * Get SCIM provisioning information for an enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -8747,12 +8755,7 @@ export interface paths { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -15636,6 +15639,31 @@ export interface components { workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; }; + /** + * Thresholds + * @description This setting will not take effect unless at least one code scanning status check is enabled. + */ + "repository-rule-params-thresholds": { + /** + * @description Code scanning alert threshold + * @enum {string} + */ + code_scanning_alert_threshold: + | "none" + | "errors" + | "errors_and_warnings" + | "all"; + /** + * @description Code scanning security alert threshold. + * @enum {string} + */ + code_scanning_security_alert_threshold: + | "none" + | "critical" + | "high_or_higher" + | "medium_or_higher" + | "all"; + }; /** * Repository Rule * @description A repository rule. @@ -16945,7 +16973,13 @@ export interface components { * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description The outcome of the job. * @example success @@ -18265,11 +18299,17 @@ export interface components { /** @example https://example.com */ details_url: string | null; /** - * @description The phase of the lifecycle that the check is currently in. + * @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. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @example neutral * @enum {string|null} @@ -18408,10 +18448,18 @@ export interface components { */ head_sha: string; /** + * @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. * @example completed * @enum {string|null} */ - status: "queued" | "in_progress" | "completed" | null; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending" + | null; /** * @example neutral * @enum {string|null} @@ -27459,7 +27507,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: unknown; + dismissed_by: Record | null; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -28628,7 +28676,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -29015,7 +29063,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -29409,7 +29457,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -31657,7 +31705,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: unknown; + license?: Record | null; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -32703,7 +32751,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -32730,10 +32778,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -33384,7 +33432,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -33411,10 +33459,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -34074,7 +34122,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -34101,10 +34149,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -35152,8 +35200,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -35163,13 +35211,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -36166,8 +36214,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -36177,7 +36225,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -36253,7 +36301,7 @@ export interface components { } | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -37854,8 +37902,8 @@ export interface components { | "too heated" | "spam" | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -37865,14 +37913,14 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: true; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -38389,8 +38437,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -38400,7 +38448,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -38476,7 +38524,7 @@ export interface components { }; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -40736,8 +40784,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -40747,13 +40795,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -43480,8 +43528,8 @@ export interface components { } | null; } & { active_lock_reason: unknown; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -43491,11 +43539,11 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: false; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; performed_via_github_app?: unknown; @@ -44119,67 +44167,77 @@ export interface components { /** @enum {string} */ action: "added"; changes?: { + /** + * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. + */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** member edited event */ - "webhook-member-edited": { - /** @enum {string} */ - action: "edited"; - /** @description The changes to the collaborator permissions */ - changes: { - old_permission?: { - /** @description The previous permissions of the collaborator if the action was edited. */ - from: string; - }; - permission?: { - from?: string | null; - to?: string | null; + /** @description The role assigned to the collaborator. */ + role_name?: { + to: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** User */ + member: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member edited event */ + "webhook-member-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the collaborator permissions */ + changes: { + old_permission?: { + /** @description The previous permissions of the collaborator if the action was edited. */ + from: string; + }; + permission?: { + from?: string | null; + to?: string | null; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -45540,8 +45598,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -45566,19 +45624,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: unknown; - bugs?: unknown; + author?: Record | null; + bugs?: Record | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: unknown; + dist?: Record | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: unknown; + repository?: Record | null; scripts?: Record; id?: string; node_version?: string; @@ -45591,7 +45649,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: unknown; + directories?: Record | null; os?: string[]; cpu?: string[]; readme?: string; @@ -75963,7 +76021,7 @@ export interface components { base_ref: string | null; /** @description The SHA of the most recent commit on `ref` before the push. */ before: string; - /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.12/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ + /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.12/rest/commits) to fetch additional commits. */ commits: { /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ added?: string[]; @@ -76394,8 +76452,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -76667,7 +76725,7 @@ export interface components { updated_at: string; version: string; }; - registry: unknown; + registry: Record | null; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -77308,7 +77366,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -77503,7 +77561,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -77852,7 +77910,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -81661,7 +81719,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: unknown[]; + steps?: (Record | null)[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -82485,7 +82543,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -83199,7 +83257,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -84295,7 +84353,7 @@ export interface components { "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.12/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: string; - /** @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`. */ + /** @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`. */ "workflow-run-status"?: | "completed" | "action_required" @@ -84364,6 +84422,11 @@ export interface components { "branch-policy-id": number; /** @description The unique identifier of the protection rule. */ "protection-rule-id": number; + /** + * @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. + * @example heads/feature-a + */ + "git-ref-only": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ @@ -88241,7 +88304,7 @@ export interface operations { }; /** * Get feeds - * @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: + * @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. * * * **Timeline**: The GitHub Enterprise Server global public timeline * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." @@ -88251,6 +88314,8 @@ export interface operations { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ "activity/get-feeds": { @@ -89729,7 +89794,7 @@ export interface operations { }; /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub Enterprise Server. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -100439,10 +100504,16 @@ export interface operations { */ started_at?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. @@ -101800,6 +101871,7 @@ export interface operations { "application/json": components["schemas"]["branch-short"][]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -101916,6 +101988,7 @@ export interface operations { "application/json": components["schemas"]["pull-request-simple"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -101979,6 +102052,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; 503: components["responses"]["service_unavailable"]; @@ -102133,7 +102207,7 @@ export interface operations { }; /** * Compare two commits - * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.12/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.12/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This 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. * @@ -103592,6 +103666,313 @@ export interface operations { }; }; }; + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-secrets": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; + }; + }; + }; + }; + }; + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-public-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + }; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-or-update-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + encrypted_value: string; + /** @description ID of the key you used to encrypt the secret. */ + key_id: string; + }; + }; + }; + responses: { + /** @description Response when creating a secret */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + 204: { + content: never; + }; + }; + }; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Default response */ + 204: { + content: never; + }; + }; + }; + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-variables": { + parameters: { + query?: { + per_page?: components["parameters"]["variables-per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; + }; + }; + }; + }; + }; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name: string; + /** @description The value of the variable. */ + value: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + }; + }; + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + name: components["parameters"]["variable-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-variable"]; + }; + }; + }; + }; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/update-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name?: string; + /** @description The value of the variable. */ + value?: string; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; /** * List repository events * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -103749,6 +104130,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -103842,6 +104224,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -103896,6 +104279,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -103913,7 +104297,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -103926,6 +104310,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -103939,7 +104324,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -103950,6 +104335,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -103984,16 +104370,20 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ "git/delete-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -104001,20 +104391,20 @@ export interface operations { 204: { content: never; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Update a reference */ + /** + * Update a reference + * @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. + */ "git/update-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** - * @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. - * @example heads/featureA - */ - ref: string; + ref: components["parameters"]["git-ref-only"]; }; }; requestBody: { @@ -104037,6 +104427,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -104120,6 +104511,7 @@ export interface operations { "application/json": components["schemas"]["git-tag"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -104170,6 +104562,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -104238,6 +104631,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -104271,6 +104665,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -109901,303 +110296,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-secrets": { - parameters: { - query?: { - per_page?: components["parameters"]["per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-public-key": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-or-update-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.12/rest/actions/secrets#get-an-environment-public-key) endpoint. */ - encrypted_value: string; - /** @description ID of the key you used to encrypt the secret. */ - key_id: string; - }; - }; - }; - responses: { - /** @description Response when creating a secret */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - 204: { - content: never; - }; - }; - }; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Default response */ - 204: { - content: never; - }; - }; - }; - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-variables": { - parameters: { - query?: { - per_page?: components["parameters"]["variables-per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - variables: components["schemas"]["actions-variable"][]; - }; - }; - }; - }; - }; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name: string; - /** @description The value of the variable. */ - value: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - }; - }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - name: components["parameters"]["variable-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-variable"]; - }; - }; - }; - }; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/update-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name?: string; - /** @description The value of the variable. */ - value?: string; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -110215,6 +110313,9 @@ export interface operations { startIndex?: components["parameters"]["start-index"]; count?: components["parameters"]["count"]; }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; }; responses: { /** @description Success, either groups were found or not found */ @@ -110239,6 +110340,11 @@ export interface operations { * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. */ "enterprise-admin/provision-enterprise-group": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; requestBody: { content: { "application/json": components["schemas"]["group"]; @@ -110272,6 +110378,7 @@ export interface operations { }; path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -110301,6 +110408,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -110334,6 +110442,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -110363,6 +110472,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -110406,6 +110516,9 @@ export interface operations { startIndex?: components["parameters"]["start-index"]; count?: components["parameters"]["count"]; }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; }; responses: { /** @description Success, either users were found or not found */ @@ -110432,6 +110545,11 @@ export interface operations { * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. */ "enterprise-admin/provision-enterprise-user": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; requestBody: { content: { "application/json": components["schemas"]["user"]; @@ -110462,6 +110580,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -110493,6 +110612,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -110526,6 +110646,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -110567,6 +110688,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -114423,12 +114545,7 @@ export interface operations { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ diff --git a/packages/openapi-types-ghes-3.8/package.json b/packages/openapi-types-ghes-3.8/package.json index de4ed0402..6471ca940 100644 --- a/packages/openapi-types-ghes-3.8/package.json +++ b/packages/openapi-types-ghes-3.8/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "14.0.0" + "openapi-version": "14.1.0" } } diff --git a/packages/openapi-types-ghes-3.8/types.d.ts b/packages/openapi-types-ghes-3.8/types.d.ts index 4cd366a69..aa2f21fcb 100644 --- a/packages/openapi-types-ghes-3.8/types.d.ts +++ b/packages/openapi-types-ghes-3.8/types.d.ts @@ -971,7 +971,7 @@ export interface paths { "/feeds": { /** * Get feeds - * @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: + * @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. * * * **Timeline**: The GitHub Enterprise Server global public timeline * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.8/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." @@ -981,6 +981,8 @@ export interface paths { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * + * By 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.8/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; @@ -1258,7 +1260,7 @@ export interface paths { "/organizations": { /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub Enterprise Server. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.8/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -4663,7 +4665,7 @@ export interface paths { "/repos/{owner}/{repo}/compare/{basehead}": { /** * Compare two commits - * @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.8/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @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.8/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This 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. * @@ -5054,6 +5056,109 @@ export interface paths { */ delete: operations["repos/delete-deployment-branch-policy"]; }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-secrets"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-public-key"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-secret"]; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [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.8/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/create-or-update-environment-secret"]; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-secret"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-variables"]; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["actions/create-environment-variable"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-variable"]; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-variable"]; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + patch: operations["actions/update-environment-variable"]; + }; "/repos/{owner}/{repo}/events": { /** * List repository events @@ -5196,9 +5301,15 @@ export interface paths { post: operations["git/create-ref"]; }; "/repos/{owner}/{repo}/git/refs/{ref}": { - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ delete: operations["git/delete-ref"]; - /** Update a reference */ + /** + * Update a reference + * @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. + */ patch: operations["git/update-ref"]; }; "/repos/{owner}/{repo}/git/tags": { @@ -6708,110 +6819,7 @@ export interface paths { */ get: operations["repos/list-public"]; }; - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-secrets"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-public-key"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-secret"]; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [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.8/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - put: operations["actions/create-or-update-environment-secret"]; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-secret"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables": { - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-variables"]; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - post: operations["actions/create-environment-variable"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-variable"]; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-variable"]; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - patch: operations["actions/update-environment-variable"]; - }; - "/scim/v2/Groups": { + "/scim/v2/enterprises/{enterprise}/Groups": { /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -6831,7 +6839,7 @@ export interface paths { */ post: operations["enterprise-admin/provision-enterprise-group"]; }; - "/scim/v2/Groups/{scim_group_id}": { + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { /** * Get SCIM provisioning information for an enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -6867,7 +6875,7 @@ export interface paths { */ patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; }; - "/scim/v2/Users": { + "/scim/v2/enterprises/{enterprise}/Users": { /** * List SCIM provisioned identities for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -6889,7 +6897,7 @@ export interface paths { */ post: operations["enterprise-admin/provision-enterprise-user"]; }; - "/scim/v2/Users/{scim_user_id}": { + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { /** * Get SCIM provisioning information for an enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -7975,12 +7983,7 @@ export interface paths { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -14514,7 +14517,13 @@ export interface components { * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description The outcome of the job. * @example success @@ -15750,11 +15759,17 @@ export interface components { /** @example https://example.com */ details_url: string | null; /** - * @description The phase of the lifecycle that the check is currently in. + * @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. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @example neutral * @enum {string|null} @@ -15893,10 +15908,18 @@ export interface components { */ head_sha: string; /** + * @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. * @example completed * @enum {string|null} */ - status: "queued" | "in_progress" | "completed" | null; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending" + | null; /** * @example neutral * @enum {string|null} @@ -24496,7 +24519,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: unknown; + dismissed_by: Record | null; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -25623,7 +25646,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -26010,7 +26033,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -26404,7 +26427,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -28630,7 +28653,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: unknown; + license?: Record | null; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -29675,7 +29698,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -29702,10 +29725,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -30356,7 +30379,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -30383,10 +30406,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -31046,7 +31069,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -31073,10 +31096,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -32124,8 +32147,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -32135,13 +32158,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -33138,8 +33161,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -33149,7 +33172,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -33225,7 +33248,7 @@ export interface components { } | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -34826,8 +34849,8 @@ export interface components { | "too heated" | "spam" | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -34837,14 +34860,14 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: true; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -35361,8 +35384,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -35372,7 +35395,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -35448,7 +35471,7 @@ export interface components { }; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -37708,8 +37731,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -37719,13 +37742,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -40452,8 +40475,8 @@ export interface components { } | null; } & { active_lock_reason: unknown; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -40463,11 +40486,11 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: false; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; performed_via_github_app?: unknown; @@ -41091,67 +41114,77 @@ export interface components { /** @enum {string} */ action: "added"; changes?: { + /** + * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. + */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** member edited event */ - "webhook-member-edited": { - /** @enum {string} */ - action: "edited"; - /** @description The changes to the collaborator permissions */ - changes: { - old_permission?: { - /** @description The previous permissions of the collaborator if the action was edited. */ - from: string; - }; - permission?: { - from?: string | null; - to?: string | null; + /** @description The role assigned to the collaborator. */ + role_name?: { + to: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** User */ + member: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member edited event */ + "webhook-member-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the collaborator permissions */ + changes: { + old_permission?: { + /** @description The previous permissions of the collaborator if the action was edited. */ + from: string; + }; + permission?: { + from?: string | null; + to?: string | null; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -42490,8 +42523,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -42516,19 +42549,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: unknown; - bugs?: unknown; + author?: Record | null; + bugs?: Record | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: unknown; + dist?: Record | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: unknown; + repository?: Record | null; scripts?: Record; id?: string; node_version?: string; @@ -42541,7 +42574,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: unknown; + directories?: Record | null; os?: string[]; cpu?: string[]; readme?: string; @@ -72814,7 +72847,7 @@ export interface components { base_ref: string | null; /** @description The SHA of the most recent commit on `ref` before the push. */ before: string; - /** @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.8/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ + /** @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.8/rest/commits) to fetch additional commits. */ commits: { /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ added?: string[]; @@ -73245,8 +73278,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -73518,7 +73551,7 @@ export interface components { updated_at: string; version: string; }; - registry: unknown; + registry: Record | null; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -74155,7 +74188,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -74350,7 +74383,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -74699,7 +74732,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -78340,7 +78373,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: unknown[]; + steps?: (Record | null)[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -79164,7 +79197,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -79878,7 +79911,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -80890,7 +80923,7 @@ export interface components { "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.8/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: string; - /** @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`. */ + /** @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`. */ "workflow-run-status"?: | "completed" | "action_required" @@ -80957,6 +80990,11 @@ export interface components { "environment-name": string; /** @description The unique identifier of the branch policy. */ "branch-policy-id": number; + /** + * @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. + * @example heads/feature-a + */ + "git-ref-only": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ @@ -84658,7 +84696,7 @@ export interface operations { }; /** * Get feeds - * @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: + * @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. * * * **Timeline**: The GitHub Enterprise Server global public timeline * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.8/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." @@ -84668,6 +84706,8 @@ export interface operations { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * + * By 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.8/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ "activity/get-feeds": { @@ -85726,7 +85766,7 @@ export interface operations { }; /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub Enterprise Server. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.8/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -95182,10 +95222,16 @@ export interface operations { */ started_at?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. @@ -96479,6 +96525,7 @@ export interface operations { "application/json": components["schemas"]["branch-short"][]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -96595,6 +96642,7 @@ export interface operations { "application/json": components["schemas"]["pull-request-simple"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -96658,6 +96706,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; 503: components["responses"]["service_unavailable"]; @@ -96812,7 +96861,7 @@ export interface operations { }; /** * Compare two commits - * @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.8/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @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.8/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This 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. * @@ -98090,6 +98139,313 @@ export interface operations { }; }; }; + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-secrets": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; + }; + }; + }; + }; + }; + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-public-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + }; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [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.8/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-or-update-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @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.8/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + encrypted_value: string; + /** @description ID of the key you used to encrypt the secret. */ + key_id: string; + }; + }; + }; + responses: { + /** @description Response when creating a secret */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + 204: { + content: never; + }; + }; + }; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Default response */ + 204: { + content: never; + }; + }; + }; + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-variables": { + parameters: { + query?: { + per_page?: components["parameters"]["variables-per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; + }; + }; + }; + }; + }; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name: string; + /** @description The value of the variable. */ + value: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + }; + }; + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + name: components["parameters"]["variable-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-variable"]; + }; + }; + }; + }; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/update-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name?: string; + /** @description The value of the variable. */ + value?: string; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; /** * List repository events * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -98247,6 +98603,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -98340,6 +98697,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -98394,6 +98752,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -98411,7 +98770,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -98424,6 +98783,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -98437,7 +98797,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -98448,6 +98808,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -98482,16 +98843,20 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ "git/delete-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -98499,20 +98864,20 @@ export interface operations { 204: { content: never; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Update a reference */ + /** + * Update a reference + * @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. + */ "git/update-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** - * @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. - * @example heads/featureA - */ - ref: string; + ref: components["parameters"]["git-ref-only"]; }; }; requestBody: { @@ -98535,6 +98900,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -98618,6 +98984,7 @@ export interface operations { "application/json": components["schemas"]["git-tag"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -98668,6 +99035,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -98736,6 +99104,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -98769,6 +99138,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -104087,303 +104457,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-secrets": { - parameters: { - query?: { - per_page?: components["parameters"]["per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-public-key": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [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.8/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-or-update-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @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.8/rest/actions/secrets#get-an-environment-public-key) endpoint. */ - encrypted_value: string; - /** @description ID of the key you used to encrypt the secret. */ - key_id: string; - }; - }; - }; - responses: { - /** @description Response when creating a secret */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - 204: { - content: never; - }; - }; - }; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Default response */ - 204: { - content: never; - }; - }; - }; - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-variables": { - parameters: { - query?: { - per_page?: components["parameters"]["variables-per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - variables: components["schemas"]["actions-variable"][]; - }; - }; - }; - }; - }; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name: string; - /** @description The value of the variable. */ - value: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - }; - }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - name: components["parameters"]["variable-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-variable"]; - }; - }; - }; - }; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/update-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name?: string; - /** @description The value of the variable. */ - value?: string; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -104401,6 +104474,9 @@ export interface operations { startIndex?: components["parameters"]["start-index"]; count?: components["parameters"]["count"]; }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; }; responses: { /** @description Success, either groups were found or not found */ @@ -104425,6 +104501,11 @@ export interface operations { * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. */ "enterprise-admin/provision-enterprise-group": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; requestBody: { content: { "application/json": components["schemas"]["group"]; @@ -104458,6 +104539,7 @@ export interface operations { }; path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -104487,6 +104569,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -104520,6 +104603,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -104549,6 +104633,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -104592,6 +104677,9 @@ export interface operations { startIndex?: components["parameters"]["start-index"]; count?: components["parameters"]["count"]; }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; }; responses: { /** @description Success, either users were found or not found */ @@ -104618,6 +104706,11 @@ export interface operations { * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. */ "enterprise-admin/provision-enterprise-user": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; requestBody: { content: { "application/json": components["schemas"]["user"]; @@ -104648,6 +104741,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -104679,6 +104773,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -104712,6 +104807,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -104753,6 +104849,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -108254,12 +108351,7 @@ export interface operations { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ diff --git a/packages/openapi-types-ghes-3.9/package.json b/packages/openapi-types-ghes-3.9/package.json index c4769f167..743819ed9 100644 --- a/packages/openapi-types-ghes-3.9/package.json +++ b/packages/openapi-types-ghes-3.9/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "14.0.0" + "openapi-version": "14.1.0" } } diff --git a/packages/openapi-types-ghes-3.9/types.d.ts b/packages/openapi-types-ghes-3.9/types.d.ts index 826a9dc35..72f61f495 100644 --- a/packages/openapi-types-ghes-3.9/types.d.ts +++ b/packages/openapi-types-ghes-3.9/types.d.ts @@ -971,7 +971,7 @@ export interface paths { "/feeds": { /** * Get feeds - * @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: + * @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. * * * **Timeline**: The GitHub Enterprise Server global public timeline * * **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)." @@ -981,6 +981,8 @@ export interface paths { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * + * By 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)." + * * **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. */ get: operations["activity/get-feeds"]; @@ -1280,7 +1282,7 @@ export interface paths { "/organizations": { /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub Enterprise Server. + * @description Lists all organizations, in the order that they were created. * * **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. */ @@ -4895,7 +4897,7 @@ export interface paths { "/repos/{owner}/{repo}/compare/{basehead}": { /** * Compare two commits - * @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)." + * @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)." * * This 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. * @@ -5293,6 +5295,109 @@ export interface paths { */ delete: operations["repos/delete-deployment-branch-policy"]; }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-secrets"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-public-key"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-secret"]; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [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)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/create-or-update-environment-secret"]; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-secret"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-variables"]; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["actions/create-environment-variable"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-variable"]; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-variable"]; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + patch: operations["actions/update-environment-variable"]; + }; "/repos/{owner}/{repo}/events": { /** * List repository events @@ -5435,9 +5540,15 @@ export interface paths { post: operations["git/create-ref"]; }; "/repos/{owner}/{repo}/git/refs/{ref}": { - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ delete: operations["git/delete-ref"]; - /** Update a reference */ + /** + * Update a reference + * @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. + */ patch: operations["git/update-ref"]; }; "/repos/{owner}/{repo}/git/tags": { @@ -6966,110 +7077,7 @@ export interface paths { */ get: operations["repos/list-public"]; }; - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-secrets"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-public-key"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-secret"]; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [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)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - put: operations["actions/create-or-update-environment-secret"]; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-secret"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables": { - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-variables"]; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - post: operations["actions/create-environment-variable"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-variable"]; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-variable"]; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - patch: operations["actions/update-environment-variable"]; - }; - "/scim/v2/Groups": { + "/scim/v2/enterprises/{enterprise}/Groups": { /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -7089,7 +7097,7 @@ export interface paths { */ post: operations["enterprise-admin/provision-enterprise-group"]; }; - "/scim/v2/Groups/{scim_group_id}": { + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { /** * Get SCIM provisioning information for an enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -7125,7 +7133,7 @@ export interface paths { */ patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; }; - "/scim/v2/Users": { + "/scim/v2/enterprises/{enterprise}/Users": { /** * List SCIM provisioned identities for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -7147,7 +7155,7 @@ export interface paths { */ post: operations["enterprise-admin/provision-enterprise-user"]; }; - "/scim/v2/Users/{scim_user_id}": { + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { /** * Get SCIM provisioning information for an enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -8350,12 +8358,7 @@ export interface paths { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -15435,7 +15438,13 @@ export interface components { * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description The outcome of the job. * @example success @@ -16677,11 +16686,17 @@ export interface components { /** @example https://example.com */ details_url: string | null; /** - * @description The phase of the lifecycle that the check is currently in. + * @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. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @example neutral * @enum {string|null} @@ -16820,10 +16835,18 @@ export interface components { */ head_sha: string; /** + * @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. * @example completed * @enum {string|null} */ - status: "queued" | "in_progress" | "completed" | null; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending" + | null; /** * @example neutral * @enum {string|null} @@ -25632,7 +25655,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: unknown; + dismissed_by: Record | null; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -26759,7 +26782,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -27146,7 +27169,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -27540,7 +27563,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -29788,7 +29811,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: unknown; + license?: Record | null; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -30833,7 +30856,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -30860,10 +30883,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -31514,7 +31537,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -31541,10 +31564,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -32204,7 +32227,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -32231,10 +32254,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -33282,8 +33305,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -33293,13 +33316,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -34296,8 +34319,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -34307,7 +34330,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -34383,7 +34406,7 @@ export interface components { } | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -35984,8 +36007,8 @@ export interface components { | "too heated" | "spam" | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -35995,14 +36018,14 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: true; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -36519,8 +36542,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -36530,7 +36553,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -36606,7 +36629,7 @@ export interface components { }; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -38866,8 +38889,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -38877,13 +38900,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -41610,8 +41633,8 @@ export interface components { } | null; } & { active_lock_reason: unknown; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -41621,11 +41644,11 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: false; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; performed_via_github_app?: unknown; @@ -42249,67 +42272,77 @@ export interface components { /** @enum {string} */ action: "added"; changes?: { + /** + * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. + */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** member edited event */ - "webhook-member-edited": { - /** @enum {string} */ - action: "edited"; - /** @description The changes to the collaborator permissions */ - changes: { - old_permission?: { - /** @description The previous permissions of the collaborator if the action was edited. */ - from: string; - }; - permission?: { - from?: string | null; - to?: string | null; + /** @description The role assigned to the collaborator. */ + role_name?: { + to: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** User */ + member: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member edited event */ + "webhook-member-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the collaborator permissions */ + changes: { + old_permission?: { + /** @description The previous permissions of the collaborator if the action was edited. */ + from: string; + }; + permission?: { + from?: string | null; + to?: string | null; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -43648,8 +43681,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -43674,19 +43707,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: unknown; - bugs?: unknown; + author?: Record | null; + bugs?: Record | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: unknown; + dist?: Record | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: unknown; + repository?: Record | null; scripts?: Record; id?: string; node_version?: string; @@ -43699,7 +43732,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: unknown; + directories?: Record | null; os?: string[]; cpu?: string[]; readme?: string; @@ -74035,7 +74068,7 @@ export interface components { base_ref: string | null; /** @description The SHA of the most recent commit on `ref` before the push. */ before: string; - /** @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. */ + /** @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. */ commits: { /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ added?: string[]; @@ -74466,8 +74499,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -74739,7 +74772,7 @@ export interface components { updated_at: string; version: string; }; - registry: unknown; + registry: Record | null; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -75380,7 +75413,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -75575,7 +75608,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -75924,7 +75957,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -79565,7 +79598,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: unknown[]; + steps?: (Record | null)[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -80389,7 +80422,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -81103,7 +81136,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -82152,7 +82185,7 @@ export interface components { "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.9/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: string; - /** @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`. */ + /** @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`. */ "workflow-run-status"?: | "completed" | "action_required" @@ -82219,6 +82252,11 @@ export interface components { "environment-name": string; /** @description The unique identifier of the branch policy. */ "branch-policy-id": number; + /** + * @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. + * @example heads/feature-a + */ + "git-ref-only": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ @@ -85931,7 +85969,7 @@ export interface operations { }; /** * Get feeds - * @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: + * @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. * * * **Timeline**: The GitHub Enterprise Server global public timeline * * **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)." @@ -85941,6 +85979,8 @@ export interface operations { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * + * By 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)." + * * **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. */ "activity/get-feeds": { @@ -87084,7 +87124,7 @@ export interface operations { }; /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub Enterprise Server. + * @description Lists all organizations, in the order that they were created. * * **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. */ @@ -97055,10 +97095,16 @@ export interface operations { */ started_at?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. @@ -98417,6 +98463,7 @@ export interface operations { "application/json": components["schemas"]["branch-short"][]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -98533,6 +98580,7 @@ export interface operations { "application/json": components["schemas"]["pull-request-simple"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -98596,6 +98644,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; 503: components["responses"]["service_unavailable"]; @@ -98750,7 +98799,7 @@ export interface operations { }; /** * Compare two commits - * @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)." + * @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)." * * This 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. * @@ -100053,6 +100102,313 @@ export interface operations { }; }; }; + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-secrets": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; + }; + }; + }; + }; + }; + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-public-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + }; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [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)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-or-update-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @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. */ + encrypted_value: string; + /** @description ID of the key you used to encrypt the secret. */ + key_id: string; + }; + }; + }; + responses: { + /** @description Response when creating a secret */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + 204: { + content: never; + }; + }; + }; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Default response */ + 204: { + content: never; + }; + }; + }; + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-variables": { + parameters: { + query?: { + per_page?: components["parameters"]["variables-per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; + }; + }; + }; + }; + }; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name: string; + /** @description The value of the variable. */ + value: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + }; + }; + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + name: components["parameters"]["variable-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-variable"]; + }; + }; + }; + }; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/update-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name?: string; + /** @description The value of the variable. */ + value?: string; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; /** * List repository events * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -100210,6 +100566,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -100303,6 +100660,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -100357,6 +100715,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -100374,7 +100733,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -100387,6 +100746,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -100400,7 +100760,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -100411,6 +100771,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -100445,16 +100806,20 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ "git/delete-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -100462,20 +100827,20 @@ export interface operations { 204: { content: never; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Update a reference */ + /** + * Update a reference + * @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. + */ "git/update-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** - * @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. - * @example heads/featureA - */ - ref: string; + ref: components["parameters"]["git-ref-only"]; }; }; requestBody: { @@ -100498,6 +100863,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -100581,6 +100947,7 @@ export interface operations { "application/json": components["schemas"]["git-tag"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -100631,6 +100998,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -100699,6 +101067,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -100732,6 +101101,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -106115,303 +106485,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-secrets": { - parameters: { - query?: { - per_page?: components["parameters"]["per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-public-key": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [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)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-or-update-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @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. */ - encrypted_value: string; - /** @description ID of the key you used to encrypt the secret. */ - key_id: string; - }; - }; - }; - responses: { - /** @description Response when creating a secret */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - 204: { - content: never; - }; - }; - }; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Default response */ - 204: { - content: never; - }; - }; - }; - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-variables": { - parameters: { - query?: { - per_page?: components["parameters"]["variables-per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - variables: components["schemas"]["actions-variable"][]; - }; - }; - }; - }; - }; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name: string; - /** @description The value of the variable. */ - value: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - }; - }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - name: components["parameters"]["variable-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-variable"]; - }; - }; - }; - }; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/update-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name?: string; - /** @description The value of the variable. */ - value?: string; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. @@ -106429,6 +106502,9 @@ export interface operations { startIndex?: components["parameters"]["start-index"]; count?: components["parameters"]["count"]; }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; }; responses: { /** @description Success, either groups were found or not found */ @@ -106453,6 +106529,11 @@ export interface operations { * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. */ "enterprise-admin/provision-enterprise-group": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; requestBody: { content: { "application/json": components["schemas"]["group"]; @@ -106486,6 +106567,7 @@ export interface operations { }; path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -106515,6 +106597,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -106548,6 +106631,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -106577,6 +106661,7 @@ export interface operations { parameters: { path: { scim_group_id: components["parameters"]["scim-group-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -106620,6 +106705,9 @@ export interface operations { startIndex?: components["parameters"]["start-index"]; count?: components["parameters"]["count"]; }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; }; responses: { /** @description Success, either users were found or not found */ @@ -106646,6 +106734,11 @@ export interface operations { * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. */ "enterprise-admin/provision-enterprise-user": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; requestBody: { content: { "application/json": components["schemas"]["user"]; @@ -106676,6 +106769,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -106707,6 +106801,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -106740,6 +106835,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; responses: { @@ -106781,6 +106877,7 @@ export interface operations { parameters: { path: { scim_user_id: components["parameters"]["scim-user-id"]; + enterprise: components["parameters"]["enterprise"]; }; }; requestBody: { @@ -110626,12 +110723,7 @@ export interface operations { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json index 3ac00cd4c..8ff3ccd6d 100644 --- a/packages/openapi-types-github.ae/package.json +++ b/packages/openapi-types-github.ae/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "14.0.0" + "openapi-version": "14.1.0" } } diff --git a/packages/openapi-types-github.ae/types.d.ts b/packages/openapi-types-github.ae/types.d.ts index ff4295b0e..7ea860fa8 100644 --- a/packages/openapi-types-github.ae/types.d.ts +++ b/packages/openapi-types-github.ae/types.d.ts @@ -21173,7 +21173,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: unknown; + dismissed_by: Record | null; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -22342,7 +22342,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -22729,7 +22729,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -23123,7 +23123,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -25339,7 +25339,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: unknown; + license?: Record | null; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -26385,7 +26385,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -26412,10 +26412,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -27066,7 +27066,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -27093,10 +27093,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -27756,7 +27756,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -27783,10 +27783,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -28834,8 +28834,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -28845,13 +28845,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -29848,8 +29848,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -29859,7 +29859,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -29935,7 +29935,7 @@ export interface components { } | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -31536,8 +31536,8 @@ export interface components { | "too heated" | "spam" | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -31547,14 +31547,14 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: true; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -32071,8 +32071,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -32082,7 +32082,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -32158,7 +32158,7 @@ export interface components { }; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -34418,8 +34418,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -34429,13 +34429,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -37162,8 +37162,8 @@ export interface components { } | null; } & { active_lock_reason: unknown; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -37173,11 +37173,11 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: false; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; performed_via_github_app?: unknown; @@ -39222,8 +39222,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -39248,19 +39248,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: unknown; - bugs?: unknown; + author?: Record | null; + bugs?: Record | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: unknown; + dist?: Record | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: unknown; + repository?: Record | null; scripts?: Record; id?: string; node_version?: string; @@ -39273,7 +39273,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: unknown; + directories?: Record | null; os?: string[]; cpu?: string[]; readme?: string; @@ -69933,8 +69933,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -70206,7 +70206,7 @@ export interface components { updated_at: string; version: string; }; - registry: unknown; + registry: Record | null; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -70843,7 +70843,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -71038,7 +71038,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -71387,7 +71387,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -74603,7 +74603,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: unknown[]; + steps?: (Record | null)[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -75368,7 +75368,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -76082,7 +76082,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -85717,7 +85717,7 @@ export interface operations { }; requestBody?: { content: { - "application/json": unknown; + "application/json": Record | null; }; }; responses: { diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json index adcd8363d..f5074eac2 100644 --- a/packages/openapi-types/package.json +++ b/packages/openapi-types/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "14.0.0" + "openapi-version": "14.1.0" } } diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index 439fc2de2..5777ed2c0 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -306,7 +306,7 @@ export interface paths { "/feeds": { /** * Get feeds - * @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: + * @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. * * * **Timeline**: The GitHub global public timeline * * **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)." @@ -316,6 +316,8 @@ export interface paths { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. * + * By 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)." + * * **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. */ get: operations["activity/get-feeds"]; @@ -661,7 +663,7 @@ export interface paths { "/organizations": { /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub. + * @description Lists all organizations, in the order that they were created. * * **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. */ @@ -4937,7 +4939,7 @@ export interface paths { "/repos/{owner}/{repo}/compare/{basehead}": { /** * Compare two commits - * @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)." + * @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)." * * This 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. * @@ -5390,6 +5392,109 @@ export interface paths { */ delete: operations["repos/disable-deployment-protection-rule"]; }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-secrets"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-public-key"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-secret"]; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [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)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/create-or-update-environment-secret"]; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-secret"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-variables"]; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["actions/create-environment-variable"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-variable"]; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-variable"]; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + patch: operations["actions/update-environment-variable"]; + }; "/repos/{owner}/{repo}/events": { /** * List repository events @@ -5532,9 +5637,15 @@ export interface paths { post: operations["git/create-ref"]; }; "/repos/{owner}/{repo}/git/refs/{ref}": { - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ delete: operations["git/delete-ref"]; - /** Update a reference */ + /** + * Update a reference + * @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. + */ patch: operations["git/update-ref"]; }; "/repos/{owner}/{repo}/git/tags": { @@ -6389,6 +6500,11 @@ export interface paths { get: operations["repos/get-pages-health-check"]; }; "/repos/{owner}/{repo}/private-vulnerability-reporting": { + /** + * Check if private vulnerability reporting is enabled for a repository + * @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)". + */ + get: operations["repos/check-private-vulnerability-reporting"]; /** * Enable private vulnerability reporting for a repository * @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)." @@ -7385,109 +7501,6 @@ export interface paths { */ get: operations["repos/list-public"]; }; - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-secrets"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-public-key"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-secret"]; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [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)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - put: operations["actions/create-or-update-environment-secret"]; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-secret"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables": { - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/list-environment-variables"]; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - post: operations["actions/create-environment-variable"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - get: operations["actions/get-environment-variable"]; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - delete: operations["actions/delete-environment-variable"]; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - patch: operations["actions/update-environment-variable"]; - }; "/search/code": { /** * Search code @@ -8840,12 +8853,7 @@ export interface paths { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -15800,6 +15808,31 @@ export interface components { workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; }; + /** + * Thresholds + * @description This setting will not take effect unless at least one code scanning status check is enabled. + */ + "repository-rule-params-thresholds": { + /** + * @description Code scanning alert threshold + * @enum {string} + */ + code_scanning_alert_threshold: + | "none" + | "errors" + | "errors_and_warnings" + | "all"; + /** + * @description Code scanning security alert threshold. + * @enum {string} + */ + code_scanning_security_alert_threshold: + | "none" + | "critical" + | "high_or_higher" + | "medium_or_higher" + | "all"; + }; /** * Repository Rule * @description A repository rule. @@ -17193,7 +17226,13 @@ export interface components { * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description The outcome of the job. * @example success @@ -18563,11 +18602,17 @@ export interface components { /** @example https://example.com */ details_url: string | null; /** - * @description The phase of the lifecycle that the check is currently in. + * @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. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @example neutral * @enum {string|null} @@ -18706,10 +18751,18 @@ export interface components { */ head_sha: string; /** + * @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. * @example completed * @enum {string|null} */ - status: "queued" | "in_progress" | "completed" | null; + status: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending" + | null; /** * @example neutral * @enum {string|null} @@ -28054,7 +28107,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: unknown; + dismissed_by: Record | null; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -29270,7 +29323,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -29657,7 +29710,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -30051,7 +30104,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: unknown; + head_commit?: Record | null; head_repository?: { archive_url?: string; assignees_url?: string; @@ -32289,7 +32342,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: unknown; + license?: Record | null; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -33335,7 +33388,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -33362,10 +33415,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -34016,7 +34069,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -34043,10 +34096,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -34706,7 +34759,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: unknown[]; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -34733,10 +34786,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -35784,8 +35837,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -35795,13 +35848,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -36798,8 +36851,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -36809,7 +36862,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -36885,7 +36938,7 @@ export interface components { } | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -38486,8 +38539,8 @@ export interface components { | "too heated" | "spam" | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -38497,14 +38550,14 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: true; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -39021,8 +39074,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -39032,7 +39085,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; /** @@ -39108,7 +39161,7 @@ export interface components { }; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -41372,8 +41425,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -41383,13 +41436,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; locked?: boolean; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; - performed_via_github_app?: unknown; + performed_via_github_app?: Record | null; reactions?: { "+1"?: number; "-1"?: number; @@ -44120,8 +44173,8 @@ export interface components { } | null; } & { active_lock_reason: unknown; - assignee?: unknown; - assignees?: unknown[]; + assignee?: Record | null; + assignees?: (Record | null)[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -44131,11 +44184,11 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: unknown[]; + labels?: (Record | null)[]; labels_url?: string; /** @enum {boolean} */ locked: false; - milestone?: unknown; + milestone?: Record | null; node_id?: string; number?: number; performed_via_github_app?: unknown; @@ -45181,10 +45234,20 @@ export interface components { /** @enum {string} */ action: "added"; changes?: { + /** + * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. + */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; }; + /** @description The role assigned to the collaborator. */ + role_name?: { + to: string; + }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; @@ -46719,8 +46782,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -46745,19 +46808,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: unknown; - bugs?: unknown; + author?: Record | null; + bugs?: Record | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: unknown; + dist?: Record | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: unknown; + repository?: Record | null; scripts?: Record; id?: string; node_version?: string; @@ -46770,7 +46833,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: unknown; + directories?: Record | null; os?: string[]; cpu?: string[]; readme?: string; @@ -79567,7 +79630,7 @@ export interface components { base_ref: string | null; /** @description The SHA of the most recent commit on `ref` before the push. */ before: string; - /** @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. */ + /** @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. */ commits: { /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ added?: string[]; @@ -80002,8 +80065,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: unknown; - manifest?: unknown; + labels?: Record | null; + manifest?: Record | null; tag?: { digest?: string; name?: string; @@ -80275,7 +80338,7 @@ export interface components { updated_at: string; version: string; }; - registry: unknown; + registry: Record | null; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -80916,7 +80979,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -81111,7 +81174,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -81460,7 +81523,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: unknown[]; + assets?: (Record | null)[]; assets_url?: string; author?: { avatar_url?: string; @@ -85222,7 +85285,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: unknown[]; + steps?: (Record | null)[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -86046,7 +86109,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -86760,7 +86823,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: unknown[]; + pull_requests?: (Record | null)[]; referenced_workflows?: | { path: string; @@ -87778,7 +87841,7 @@ export interface components { "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: string; - /** @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`. */ + /** @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`. */ "workflow-run-status"?: | "completed" | "action_required" @@ -87847,6 +87910,11 @@ export interface components { "branch-policy-id": number; /** @description The unique identifier of the protection rule. */ "protection-rule-id": number; + /** + * @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. + * @example heads/feature-a + */ + "git-ref-only": string; /** @description A user ID. Only return users with an ID greater than this ID. */ "since-user"?: number; /** @description The number that identifies the issue. */ @@ -89264,7 +89332,7 @@ export interface operations { }; /** * Get feeds - * @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: + * @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. * * * **Timeline**: The GitHub global public timeline * * **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)." @@ -89274,6 +89342,8 @@ export interface operations { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. * + * By 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)." + * * **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. */ "activity/get-feeds": { @@ -90531,7 +90601,7 @@ export interface operations { }; /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub. + * @description Lists all organizations, in the order that they were created. * * **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. */ @@ -92638,6 +92708,10 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + /** @description There is a problem with your account's associated payment method. */ + 422: { + content: never; + }; 500: components["responses"]["internal_error"]; }; }; @@ -102267,10 +102341,16 @@ export interface operations { */ started_at?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. @@ -104089,6 +104169,7 @@ export interface operations { "application/json": components["schemas"]["branch-short"][]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -104205,6 +104286,7 @@ export interface operations { "application/json": components["schemas"]["pull-request-simple"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -104268,6 +104350,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; 503: components["responses"]["service_unavailable"]; @@ -104452,7 +104535,7 @@ export interface operations { }; /** * Compare two commits - * @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)." + * @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)." * * This 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. * @@ -105911,6 +105994,313 @@ export interface operations { }; }; }; + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-secrets": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; + }; + }; + }; + }; + }; + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-public-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + }; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [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)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-or-update-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @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. */ + encrypted_value: string; + /** @description ID of the key you used to encrypt the secret. */ + key_id: string; + }; + }; + }; + responses: { + /** @description Response when creating a secret */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + 204: { + content: never; + }; + }; + }; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Default response */ + 204: { + content: never; + }; + }; + }; + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/list-environment-variables": { + parameters: { + query?: { + per_page?: components["parameters"]["variables-per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; + }; + }; + }; + }; + }; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/create-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name: string; + /** @description The value of the variable. */ + value: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + }; + }; + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/get-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + name: components["parameters"]["variable-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-variable"]; + }; + }; + }; + }; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/delete-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/update-environment-variable": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: components["parameters"]["variable-name"]; + environment_name: components["parameters"]["environment-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name?: string; + /** @description The value of the variable. */ + value?: string; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; /** * List repository events * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -106068,6 +106458,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -106161,6 +106552,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -106215,6 +106607,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -106232,7 +106625,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -106245,6 +106638,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"][]; }; }; + 409: components["responses"]["conflict"]; }; }; /** @@ -106258,7 +106652,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -106269,6 +106663,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -106303,16 +106698,20 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ "git/delete-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["git-ref-only"]; }; }; responses: { @@ -106320,20 +106719,20 @@ export interface operations { 204: { content: never; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** Update a reference */ + /** + * Update a reference + * @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. + */ "git/update-ref": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** - * @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. - * @example heads/featureA - */ - ref: string; + ref: components["parameters"]["git-ref-only"]; }; }; requestBody: { @@ -106356,6 +106755,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -106439,6 +106839,7 @@ export interface operations { "application/json": components["schemas"]["git-tag"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -106489,6 +106890,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; /** @@ -106557,6 +106959,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -106590,6 +106993,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -108779,6 +109183,9 @@ export interface operations { */ "licenses/get-for-repo": { parameters: { + query?: { + ref?: components["parameters"]["git-ref"]; + }; path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; @@ -109506,6 +109913,30 @@ export interface operations { }; }; }; + /** + * Check if private vulnerability reporting is enabled for a repository + * @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)". + */ + "repos/check-private-vulnerability-reporting": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Private vulnerability reporting status */ + 200: { + content: { + "application/json": { + /** @description Whether or not private vulnerability reporting is enabled for the repository. */ + enabled: boolean; + }; + }; + }; + 422: components["responses"]["bad_request"]; + }; + }; /** * Enable private vulnerability reporting for a repository * @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)." @@ -112991,303 +113422,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-secrets": { - parameters: { - query?: { - per_page?: components["parameters"]["per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-public-key": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [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)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-or-update-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @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. */ - encrypted_value: string; - /** @description ID of the key you used to encrypt the secret. */ - key_id: string; - }; - }; - }; - responses: { - /** @description Response when creating a secret */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - 204: { - content: never; - }; - }; - }; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-secret": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - secret_name: components["parameters"]["secret-name"]; - }; - }; - responses: { - /** @description Default response */ - 204: { - content: never; - }; - }; - }; - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/list-environment-variables": { - parameters: { - query?: { - per_page?: components["parameters"]["variables-per-page"]; - page?: components["parameters"]["page"]; - }; - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - }; - content: { - "application/json": { - total_count: number; - variables: components["schemas"]["actions-variable"][]; - }; - }; - }; - }; - }; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/create-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name: string; - /** @description The value of the variable. */ - value: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - }; - }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/get-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - environment_name: components["parameters"]["environment-name"]; - name: components["parameters"]["variable-name"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["actions-variable"]; - }; - }; - }; - }; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/delete-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ - "actions/update-environment-variable": { - parameters: { - path: { - repository_id: components["parameters"]["repository-id"]; - name: components["parameters"]["variable-name"]; - environment_name: components["parameters"]["environment-name"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name?: string; - /** @description The value of the variable. */ - value?: string; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; /** * Search code * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). @@ -117822,12 +117956,7 @@ export interface operations { * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * 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 via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * 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). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */