From ff50f18f3a411ddb53f4376966eb35badec8acb5 Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Thu, 15 Sep 2022 06:45:21 -0700 Subject: [PATCH] feat: add support for new "List CodeQL databases for a repository" (`GET /repos/{owner}/{repo}/code-scanning/codeql/databases`) and "Get a CodeQL database for a repository" (`GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}`) APIs, plus description tweaks (#246) WIP --- cache/api.github.com.json | 336 ++++++++- cache/ghes-3.2.json | 57 +- cache/ghes-3.3.json | 57 +- cache/ghes-3.4.json | 57 +- cache/ghes-3.5.json | 163 ++++- cache/ghes-3.6.json | 686 ++++++++++++++---- cache/github.ae.json | 101 ++- packages/openapi-types-ghes-3.2/package.json | 2 +- packages/openapi-types-ghes-3.2/types.d.ts | 69 +- packages/openapi-types-ghes-3.3/package.json | 2 +- packages/openapi-types-ghes-3.3/types.d.ts | 69 +- packages/openapi-types-ghes-3.4/package.json | 2 +- packages/openapi-types-ghes-3.4/types.d.ts | 69 +- packages/openapi-types-ghes-3.5/package.json | 2 +- packages/openapi-types-ghes-3.5/types.d.ts | 120 ++- packages/openapi-types-ghes-3.6/package.json | 2 +- packages/openapi-types-ghes-3.6/types.d.ts | 434 +++++++++-- packages/openapi-types-github.ae/package.json | 2 +- packages/openapi-types-github.ae/types.d.ts | 91 ++- packages/openapi-types/package.json | 2 +- packages/openapi-types/types.d.ts | 192 ++++- 21 files changed, 2022 insertions(+), 493 deletions(-) diff --git a/cache/api.github.com.json b/cache/api.github.com.json index 0c8823da5..74f969e27 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.12.0", + "version": "7.13.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": { @@ -5531,7 +5531,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -5549,7 +5549,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -5791,7 +5791,7 @@ "type": "string" }, "mode": { - "description": "The rendering mode. Can be either `markdown` or `gfm`.", + "description": "The rendering mode.", "enum": [ "markdown", "gfm" @@ -12637,7 +12637,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -12655,7 +12655,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -14309,7 +14309,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -28404,6 +28404,133 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/code-scanning/codeql/databases": { + "get": { + "summary": "List CodeQL databases for a repository", + "description": "Lists the CodeQL databases that are available in a repository.\n\nFor private repositories, you must use an access token with the `security_events` scope.\nFor public repositories, you can use tokens with the `security_events` or `public_repo` scope.\nGitHub Apps must have the `contents` read permission to use this endpoint.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-codeql-databases", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/code-scanning#list-codeql-databases" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-scanning-codeql-database" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-codeql-databases" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { + "get": { + "summary": "Get a CodeQL database for a repository", + "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nFor private repositories, you must use an access token with the `security_events` scope.\nFor public repositories, you can use tokens with the `security_events` or `public_repo` scope.\nGitHub Apps must have the `contents` read permission to use this endpoint.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-codeql-database", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/code-scanning#get-codeql-database" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "language", + "in": "path", + "description": "The language of the CodeQL database.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-codeql-database" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-codeql-database" + } + } + } + } + }, + "302": { + "$ref": "#/components/responses/found" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": null + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", @@ -31182,7 +31309,7 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.", + "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -31361,7 +31488,7 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -33344,7 +33471,7 @@ }, { "name": "sort", - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", + "description": "The sort order. `stargazers` will sort by star count.", "in": "query", "required": false, "schema": { @@ -36386,7 +36513,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -36431,7 +36558,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -40951,7 +41078,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -41164,7 +41291,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", + "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.", "in": "query", "required": false, "schema": { @@ -41180,7 +41307,7 @@ }, { "name": "direction", - "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", + "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", "in": "query", "required": false, "schema": { @@ -41386,7 +41513,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -42147,7 +42274,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -55014,7 +55141,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -55032,7 +55159,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -55515,7 +55642,7 @@ "parameters": [ { "name": "state", - "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.", + "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.", "in": "query", "required": false, "schema": { @@ -59161,7 +59288,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -63967,7 +64094,7 @@ "nullable": true }, "secret-scanning-alert-state": { - "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", "type": "string", "enum": [ "open", @@ -72562,7 +72689,16 @@ "description": "The outcome of the job.", "example": "success", "type": "string", - "nullable": true + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ] }, "started_at": { "description": "The time that the job started, in ISO 8601 format.", @@ -75658,6 +75794,62 @@ "confirm_delete_url" ] }, + "code-scanning-codeql-database": { + "title": "CodeQL Database", + "description": "A CodeQL database.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the CodeQL database." + }, + "name": { + "type": "string", + "description": "The name of the CodeQL database." + }, + "language": { + "type": "string", + "description": "The language of the CodeQL database." + }, + "uploader": { + "$ref": "#/components/schemas/simple-user" + }, + "content_type": { + "type": "string", + "description": "The MIME type of the CodeQL database file." + }, + "size": { + "type": "integer", + "description": "The size of the CodeQL database file in bytes." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property." + } + }, + "required": [ + "id", + "name", + "language", + "uploader", + "content_type", + "size", + "created_at", + "updated_at", + "url" + ] + }, "code-scanning-analysis-sarif-file": { "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning).\"", "type": "string" @@ -100492,6 +100684,102 @@ "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete" } }, + "code-scanning-codeql-databases": { + "value": [ + { + "id": 1, + "name": "database.zip", + "language": "java", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "content_type": "application/zip", + "size": 1024, + "created_at": "2022-09-12T12:14:32Z", + "updated_at": "2022-09-12T12:14:32Z", + "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java" + }, + { + "id": 2, + "name": "database.zip", + "language": "ruby", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "content_type": "application/zip", + "size": 1024, + "created_at": "2022-09-12T12:14:32Z", + "updated_at": "2022-09-12T12:14:32Z", + "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby" + } + ] + }, + "code-scanning-codeql-database": { + "value": { + "id": 1, + "name": "database.zip", + "language": "java", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "content_type": "application/zip", + "size": 1024, + "created_at": "2022-09-12T12:14:32Z", + "updated_at": "2022-09-12T12:14:32Z", + "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java" + } + }, "code-scanning-sarif-upload": { "summary": "Default response", "value": { @@ -112906,7 +113194,7 @@ } }, "code_scanning_forbidden_write": { - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { diff --git a/cache/ghes-3.2.json b/cache/ghes-3.2.json index 413304e9a..82cb577e0 100644 --- a/cache/ghes-3.2.json +++ b/cache/ghes-3.2.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.12.0", + "version": "7.13.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": { @@ -8270,7 +8270,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -8288,7 +8288,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -8547,7 +8547,7 @@ "type": "string" }, "mode": { - "description": "The rendering mode. Can be either `markdown` or `gfm`.", + "description": "The rendering mode.", "enum": [ "markdown", "gfm" @@ -12408,7 +12408,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -12426,7 +12426,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -13339,7 +13339,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -27447,7 +27447,7 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.", + "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.2/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -27626,7 +27626,7 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.2/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -29243,7 +29243,7 @@ }, { "name": "sort", - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", + "description": "The sort order. `stargazers` will sort by star count.", "in": "query", "required": false, "schema": { @@ -31576,7 +31576,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -31621,7 +31621,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -36268,7 +36268,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -36493,7 +36493,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", + "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.", "in": "query", "required": false, "schema": { @@ -36509,7 +36509,7 @@ }, { "name": "direction", - "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", + "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", "in": "query", "required": false, "schema": { @@ -36721,7 +36721,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -37401,7 +37401,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -46946,7 +46946,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -46964,7 +46964,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -47341,7 +47341,7 @@ "parameters": [ { "name": "state", - "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.", + "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.", "in": "query", "required": false, "schema": { @@ -49480,7 +49480,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -60611,7 +60611,16 @@ "description": "The outcome of the job.", "example": "success", "type": "string", - "nullable": true + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ] }, "started_at": { "description": "The time that the job started, in ISO 8601 format.", @@ -71305,7 +71314,7 @@ "readOnly": true }, "secret-scanning-alert-state": { - "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", "type": "string", "enum": [ "open", @@ -96045,7 +96054,7 @@ } }, "code_scanning_forbidden_write": { - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { diff --git a/cache/ghes-3.3.json b/cache/ghes-3.3.json index ae3119248..a34f77969 100644 --- a/cache/ghes-3.3.json +++ b/cache/ghes-3.3.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.12.0", + "version": "7.13.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": { @@ -8237,7 +8237,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -8255,7 +8255,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -8497,7 +8497,7 @@ "type": "string" }, "mode": { - "description": "The rendering mode. Can be either `markdown` or `gfm`.", + "description": "The rendering mode.", "enum": [ "markdown", "gfm" @@ -12392,7 +12392,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -12410,7 +12410,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -13278,7 +13278,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -27320,7 +27320,7 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.", + "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.3/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -27499,7 +27499,7 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.3/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -29048,7 +29048,7 @@ }, { "name": "sort", - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", + "description": "The sort order. `stargazers` will sort by star count.", "in": "query", "required": false, "schema": { @@ -31363,7 +31363,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -31408,7 +31408,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -36000,7 +36000,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -36213,7 +36213,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", + "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.", "in": "query", "required": false, "schema": { @@ -36229,7 +36229,7 @@ }, { "name": "direction", - "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", + "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", "in": "query", "required": false, "schema": { @@ -36435,7 +36435,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -37066,7 +37066,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -46515,7 +46515,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -46533,7 +46533,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -46893,7 +46893,7 @@ "parameters": [ { "name": "state", - "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.", + "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.", "in": "query", "required": false, "schema": { @@ -48987,7 +48987,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -58566,7 +58566,7 @@ "readOnly": true }, "secret-scanning-alert-state": { - "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", "type": "string", "enum": [ "open", @@ -61263,7 +61263,16 @@ "description": "The outcome of the job.", "example": "success", "type": "string", - "nullable": true + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ] }, "started_at": { "description": "The time that the job started, in ISO 8601 format.", @@ -96809,7 +96818,7 @@ } }, "code_scanning_forbidden_write": { - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { diff --git a/cache/ghes-3.4.json b/cache/ghes-3.4.json index 39727938d..7033fc0d5 100644 --- a/cache/ghes-3.4.json +++ b/cache/ghes-3.4.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.12.0", + "version": "7.13.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": { @@ -8375,7 +8375,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -8393,7 +8393,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -8635,7 +8635,7 @@ "type": "string" }, "mode": { - "description": "The rendering mode. Can be either `markdown` or `gfm`.", + "description": "The rendering mode.", "enum": [ "markdown", "gfm" @@ -13399,7 +13399,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -13417,7 +13417,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -14552,7 +14552,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -28880,7 +28880,7 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.", + "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.4/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -29059,7 +29059,7 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.4/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -30889,7 +30889,7 @@ }, { "name": "sort", - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", + "description": "The sort order. `stargazers` will sort by star count.", "in": "query", "required": false, "schema": { @@ -33216,7 +33216,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -33261,7 +33261,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -37859,7 +37859,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -38072,7 +38072,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", + "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.", "in": "query", "required": false, "schema": { @@ -38088,7 +38088,7 @@ }, { "name": "direction", - "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", + "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", "in": "query", "required": false, "schema": { @@ -38294,7 +38294,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -38925,7 +38925,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -48537,7 +48537,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -48555,7 +48555,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -48915,7 +48915,7 @@ "parameters": [ { "name": "state", - "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.", + "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.", "in": "query", "required": false, "schema": { @@ -51327,7 +51327,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -56453,7 +56453,7 @@ "readOnly": true }, "secret-scanning-alert-state": { - "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", "type": "string", "enum": [ "open", @@ -63190,7 +63190,16 @@ "description": "The outcome of the job.", "example": "success", "type": "string", - "nullable": true + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ] }, "started_at": { "description": "The time that the job started, in ISO 8601 format.", @@ -99934,7 +99943,7 @@ } }, "code_scanning_forbidden_write": { - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { diff --git a/cache/ghes-3.5.json b/cache/ghes-3.5.json index 3dce32587..e6614eb9e 100644 --- a/cache/ghes-3.5.json +++ b/cache/ghes-3.5.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.12.0", + "version": "7.13.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": { @@ -8555,7 +8555,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -8573,7 +8573,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -8821,7 +8821,7 @@ "type": "string" }, "mode": { - "description": "The rendering mode. Can be either `markdown` or `gfm`.", + "description": "The rendering mode.", "enum": [ "markdown", "gfm" @@ -13954,7 +13954,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -13972,7 +13972,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -15131,7 +15131,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -30100,7 +30100,7 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.", + "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.5/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -30279,7 +30279,7 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.5/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -32115,7 +32115,7 @@ }, { "name": "sort", - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", + "description": "The sort order. `stargazers` will sort by star count.", "in": "query", "required": false, "schema": { @@ -34448,7 +34448,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -34493,7 +34493,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -39133,7 +39133,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -39346,7 +39346,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", + "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.", "in": "query", "required": false, "schema": { @@ -39362,7 +39362,7 @@ }, { "name": "direction", - "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", + "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", "in": "query", "required": false, "schema": { @@ -39580,7 +39580,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -40223,7 +40223,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -50066,7 +50066,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -50084,7 +50084,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -50450,7 +50450,7 @@ "parameters": [ { "name": "state", - "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.", + "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.", "in": "query", "required": false, "schema": { @@ -52922,7 +52922,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -53641,6 +53641,112 @@ } } }, + "/orgs/{org}/external-group/{group_id}": { + "get": { + "summary": "Get an external group", + "description": "This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6", + "tags": [ + "teams" + ], + "operationId": "teams/external-idp-group-info-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#external-idp-group-info-for-an-organization" + }, + "x-octokit": { + "ghes-3.6": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + } + }, + "/orgs/{org}/external-groups": { + "get": { + "summary": "List external groups in an organization", + "description": "This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6", + "tags": [ + "teams" + ], + "operationId": "teams/list-external-idp-groups-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#list-external-idp-groups-for-an-organization" + }, + "x-octokit": { + "ghes-3.6": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + } + }, + "/orgs/{org}/teams/{team_slug}/external-groups": { + "get": { + "summary": "List a connection between an external group and a team", + "description": "This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6", + "tags": [ + "teams" + ], + "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#list-external-idp-group-team-connection" + }, + "x-octokit": { + "ghes-3.6": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + }, + "delete": { + "summary": "Remove the connection between an external group and a team", + "description": "This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6", + "tags": [ + "teams" + ], + "operationId": "teams/unlink-external-idp-group-from-team-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#unlink-external-idp-group-team-connection" + }, + "x-octokit": { + "ghes-3.6": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + }, + "patch": { + "summary": "Update the connection between an external group and a team", + "description": "This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6", + "tags": [ + "teams" + ], + "operationId": "teams/link-external-idp-group-to-team-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#link-external-idp-group-team-connection" + }, + "x-octokit": { + "ghes-3.6": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + } + }, "/repos/{owner}/{repo}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for a repository", @@ -57745,7 +57851,7 @@ "readOnly": true }, "secret-scanning-alert-state": { - "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", "type": "string", "enum": [ "open", @@ -64887,7 +64993,16 @@ "description": "The outcome of the job.", "example": "success", "type": "string", - "nullable": true + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ] }, "started_at": { "description": "The time that the job started, in ISO 8601 format.", @@ -102053,7 +102168,7 @@ } }, "code_scanning_forbidden_write": { - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { diff --git a/cache/ghes-3.6.json b/cache/ghes-3.6.json index 2278bdcea..bc7139d18 100644 --- a/cache/ghes-3.6.json +++ b/cache/ghes-3.6.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.12.0", + "version": "7.13.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": { @@ -9017,7 +9017,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -9035,7 +9035,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -9277,7 +9277,7 @@ "type": "string" }, "mode": { - "description": "The rendering mode. Can be either `markdown` or `gfm`.", + "description": "The rendering mode.", "enum": [ "markdown", "gfm" @@ -13516,6 +13516,122 @@ "x-octokit": {} } }, + "/orgs/{org}/external-group/{group_id}": { + "get": { + "summary": "Get an external group", + "description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "tags": [ + "teams" + ], + "operationId": "teams/external-idp-group-info-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#external-idp-group-info-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/group-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/external-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/external-group" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "external-groups" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/external-groups": { + "get": { + "summary": "List external groups in an organization", + "description": "Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "tags": [ + "teams" + ], + "operationId": "teams/list-external-idp-groups-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#list-external-idp-groups-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "name": "page", + "description": "Page token", + "in": "query", + "schema": { + "type": "integer" + } + }, + { + "name": "display_name", + "description": "Limits the list to groups containing the text in the group name", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/external-groups" + }, + "examples": { + "default": { + "$ref": "#/components/examples/external-groups" + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "external-groups" + }, + "x-octokit": {} + } + }, "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", @@ -14388,7 +14504,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -14406,7 +14522,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -15565,7 +15681,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -17774,6 +17890,155 @@ "x-octokit": {} } }, + "/orgs/{org}/teams/{team_slug}/external-groups": { + "get": { + "summary": "List a connection between an external group and a team", + "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "tags": [ + "teams" + ], + "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#list-external-idp-group-team-connection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/external-groups" + }, + "examples": { + "default": { + "$ref": "#/components/examples/external-groups" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "external-groups" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update the connection between an external group and a team", + "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "tags": [ + "teams" + ], + "operationId": "teams/link-external-idp-group-to-team-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#link-external-idp-group-team-connection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group_id": { + "type": "integer", + "description": "External Group Id", + "example": 1 + } + }, + "required": [ + "group_id" + ] + }, + "examples": { + "default": { + "value": { + "group_id": 123 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/external-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/external-group" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "external-groups" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove the connection between an external group and a team", + "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "teams" + ], + "operationId": "teams/unlink-external-idp-group-from-team-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#unlink-external-idp-group-team-connection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "external-groups" + }, + "x-octokit": {} + } + }, "/orgs/{org}/teams/{team_slug}/members": { "get": { "summary": "List team members", @@ -30588,7 +30853,7 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.", + "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.6/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -30767,7 +31032,7 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.6/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -32665,7 +32930,7 @@ }, { "name": "sort", - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", + "description": "The sort order. `stargazers` will sort by star count.", "in": "query", "required": false, "schema": { @@ -34986,7 +35251,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -35031,7 +35296,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -39665,7 +39930,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -39878,7 +40143,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", + "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.", "in": "query", "required": false, "schema": { @@ -39894,7 +40159,7 @@ }, { "name": "direction", - "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", + "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", "in": "query", "required": false, "schema": { @@ -40100,7 +40365,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -40731,7 +40996,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -50599,7 +50864,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -50617,7 +50882,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -50977,7 +51242,7 @@ "parameters": [ { "name": "state", - "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.", + "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.", "in": "query", "required": false, "schema": { @@ -53378,7 +53643,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -54620,50 +54885,6 @@ } } }, - "/orgs/{org}/external-group/{group_id}": { - "get": { - "summary": "Get an external group", - "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", - "tags": [ - "teams" - ], - "operationId": "teams/external-idp-group-info-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/teams#external-idp-group-info-for-an-organization" - }, - "x-octokit": { - "api.github.com": "removed" - }, - "responses": { - "501": { - "description": "Not Implemented" - } - } - } - }, - "/orgs/{org}/external-groups": { - "get": { - "summary": "List external groups in an organization", - "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", - "tags": [ - "teams" - ], - "operationId": "teams/list-external-idp-groups-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/teams#list-external-idp-groups-for-an-organization" - }, - "x-octokit": { - "api.github.com": "removed" - }, - "responses": { - "501": { - "description": "Not Implemented" - } - } - } - }, "/orgs/{org}/failed_invitations": { "get": { "summary": "List failed organization invitations", @@ -55310,68 +55531,6 @@ } } }, - "/orgs/{org}/teams/{team_slug}/external-groups": { - "get": { - "summary": "List a connection between an external group and a team", - "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", - "tags": [ - "teams" - ], - "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/teams#list-external-idp-group-team-connection" - }, - "x-octokit": { - "api.github.com": "removed" - }, - "responses": { - "501": { - "description": "Not Implemented" - } - } - }, - "delete": { - "summary": "Remove the connection between an external group and a team", - "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", - "tags": [ - "teams" - ], - "operationId": "teams/unlink-external-idp-group-from-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/teams#unlink-external-idp-group-team-connection" - }, - "x-octokit": { - "api.github.com": "removed" - }, - "responses": { - "501": { - "description": "Not Implemented" - } - } - }, - "patch": { - "summary": "Update the connection between an external group and a team", - "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", - "tags": [ - "teams" - ], - "operationId": "teams/link-external-idp-group-to-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/teams#link-external-idp-group-team-connection" - }, - "x-octokit": { - "api.github.com": "removed" - }, - "responses": { - "501": { - "description": "Not Implemented" - } - } - } - }, "/orgs/{org}/teams/{team_slug}/invitations": { "get": { "summary": "List pending team invitations", @@ -55672,6 +55831,50 @@ } } }, + "/repos/{owner}/{repo}/code-scanning/codeql/databases": { + "get": { + "summary": "List CodeQL databases for a repository", + "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-codeql-databases", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/code-scanning#list-codeql-databases" + }, + "x-octokit": { + "api.github.com": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { + "get": { + "summary": "Get a CodeQL database for a repository", + "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-codeql-database", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/code-scanning#get-codeql-database" + }, + "x-octokit": { + "api.github.com": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + } + }, "/repos/{owner}/{repo}/codespaces": { "get": { "summary": "List codespaces in a repository for the authenticated user", @@ -62145,7 +62348,7 @@ "readOnly": true }, "secret-scanning-alert-state": { - "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", "type": "string", "enum": [ "open", @@ -66646,6 +66849,164 @@ "key" ] }, + "external-group": { + "title": "ExternalGroup", + "description": "Information about an external group's usage and its members", + "type": "object", + "required": [ + "group_id", + "group_name", + "teams", + "members" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "example": 1, + "type": "integer" + }, + "group_name": { + "description": "The display name for the group", + "example": "group-azuread-test", + "type": "string" + }, + "updated_at": { + "description": "The date when the group was last updated_at", + "example": "2021-01-03 22:27:15:000 -700", + "type": "string" + }, + "teams": { + "description": "An array of teams linked to this group", + "example": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ], + "type": "array", + "items": { + "type": "object", + "required": [ + "team_id", + "team_name" + ], + "properties": { + "team_id": { + "description": "The id for a team", + "example": 1, + "type": "integer" + }, + "team_name": { + "description": "The name of the team", + "example": "team-test", + "type": "string" + } + } + } + }, + "members": { + "description": "An array of external members linked to this group", + "example": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ], + "type": "array", + "items": { + "type": "object", + "required": [ + "member_id", + "member_login", + "member_name", + "member_email" + ], + "properties": { + "member_id": { + "description": "The internal user ID of the identity", + "example": 1, + "type": "integer" + }, + "member_login": { + "description": "The handle/login for the user", + "example": "mona-lisa_eocsaxrs", + "type": "string" + }, + "member_name": { + "description": "The user display name/profile name", + "example": "Mona Lisa", + "type": "string" + }, + "member_email": { + "description": "An email attached to a user", + "example": "mona_lisa@github.com", + "type": "string" + } + } + } + } + } + }, + "external-groups": { + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "example": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" + }, + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ], + "type": "array", + "items": { + "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "example": 1, + "type": "integer" + }, + "group_name": { + "description": "The display name of the group", + "example": "group-azuread-test", + "type": "string" + }, + "updated_at": { + "description": "The time of the last update for this group", + "example": "2019-06-03 22:27:15:000 -700", + "type": "string" + } + } + } + } + } + }, "org-hook": { "title": "Org Hook", "description": "Org Hook", @@ -69418,7 +69779,16 @@ "description": "The outcome of the job.", "example": "success", "type": "string", - "nullable": true + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ] }, "started_at": { "description": "The time that the job started, in ISO 8601 format.", @@ -89005,6 +89375,53 @@ } ] }, + "external-group": { + "value": { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00", + "teams": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ], + "members": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ] + } + }, + "external-groups": { + "value": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" + }, + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" + } + ] + } + }, "org-hook-items": { "value": [ { @@ -106185,6 +106602,15 @@ "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" } }, + "group-id": { + "name": "group_id", + "description": "The unique identifier of the group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "migration-id": { "name": "migration_id", "description": "The unique identifier of the migration.", @@ -106948,7 +107374,7 @@ } }, "code_scanning_forbidden_write": { - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { diff --git a/cache/github.ae.json b/cache/github.ae.json index 762aa3108..8cc1eea7a 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.12.0", + "version": "7.13.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": { @@ -6350,7 +6350,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -6368,7 +6368,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -6616,7 +6616,7 @@ "type": "string" }, "mode": { - "description": "The rendering mode. Can be either `markdown` or `gfm`.", + "description": "The rendering mode.", "enum": [ "markdown", "gfm" @@ -10230,7 +10230,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -10248,7 +10248,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -11176,7 +11176,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -25185,7 +25185,7 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.", + "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/github-ae@latest/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -25364,7 +25364,7 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/github-ae@latest/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -26919,7 +26919,7 @@ }, { "name": "sort", - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", + "description": "The sort order. `stargazers` will sort by star count.", "in": "query", "required": false, "schema": { @@ -29258,7 +29258,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -29303,7 +29303,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -33755,7 +33755,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -33968,7 +33968,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", + "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.", "in": "query", "required": false, "schema": { @@ -33984,7 +33984,7 @@ }, { "name": "direction", - "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", + "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", "in": "query", "required": false, "schema": { @@ -34196,7 +34196,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -34845,7 +34845,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "The direction to sort results. Ignored without `sort` parameter.", "in": "query", "required": false, "schema": { @@ -43051,7 +43051,7 @@ }, { "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { @@ -43069,7 +43069,7 @@ }, { "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "description": "What to sort results by.", "in": "query", "required": false, "schema": { @@ -43435,7 +43435,7 @@ "parameters": [ { "name": "state", - "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.", + "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.", "in": "query", "required": false, "schema": { @@ -45773,7 +45773,7 @@ }, { "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "description": "Indicates the state of the projects to return.", "in": "query", "required": false, "schema": { @@ -49155,6 +49155,50 @@ } } }, + "/repos/{owner}/{repo}/code-scanning/codeql/databases": { + "get": { + "summary": "List CodeQL databases for a repository", + "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-codeql-databases", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/code-scanning#list-codeql-databases" + }, + "x-octokit": { + "api.github.com": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { + "get": { + "summary": "Get a CodeQL database for a repository", + "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-codeql-database", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/code-scanning#get-codeql-database" + }, + "x-octokit": { + "api.github.com": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + } + }, "/repos/{owner}/{repo}/codespaces": { "get": { "summary": "List codespaces in a repository for the authenticated user", @@ -61769,7 +61813,16 @@ "description": "The outcome of the job.", "example": "success", "type": "string", - "nullable": true + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ] }, "started_at": { "description": "The time that the job started, in ISO 8601 format.", @@ -72947,7 +73000,7 @@ "readOnly": true }, "secret-scanning-alert-state": { - "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", "type": "string", "enum": [ "open", @@ -96641,7 +96694,7 @@ } }, "code_scanning_forbidden_write": { - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { diff --git a/packages/openapi-types-ghes-3.2/package.json b/packages/openapi-types-ghes-3.2/package.json index 921a85232..679ccdcde 100644 --- a/packages/openapi-types-ghes-3.2/package.json +++ b/packages/openapi-types-ghes-3.2/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.12.0" + "openapi-version": "7.13.0" } } diff --git a/packages/openapi-types-ghes-3.2/types.d.ts b/packages/openapi-types-ghes-3.2/types.d.ts index fb0598767..66e31de59 100644 --- a/packages/openapi-types-ghes-3.2/types.d.ts +++ b/packages/openapi-types-ghes-3.2/types.d.ts @@ -2746,7 +2746,11 @@ export interface paths { * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ get: operations["repos/get-content"]; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.2/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ put: operations["repos/create-or-update-file-contents"]; /** * Deletes a file in a repository. @@ -2756,6 +2760,8 @@ export interface paths { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.2/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -9859,8 +9865,19 @@ export interface components { /** * @description The outcome of the job. * @example success + * @enum {string|null} */ - conclusion: string | null; + conclusion: + | ( + | "success" + | "failure" + | "neutral" + | "cancelled" + | "skipped" + | "timed_out" + | "action_required" + ) + | null; /** * Format: date-time * @description The time that the job started, in ISO 8601 format. @@ -14598,7 +14615,7 @@ export interface components { */ "alert-updated-at": string; /** - * @description Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. + * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. * @enum {string} */ "secret-scanning-alert-state": "open" | "resolved"; @@ -15662,7 +15679,7 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** Response if the repository is archived or if github advanced security is not enabled for this repository */ + /** Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { content: { "application/json": components["schemas"]["basic-error"]; @@ -19095,11 +19112,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -19186,7 +19203,7 @@ export interface operations { /** @description The Markdown text to render in HTML. */ text: string; /** - * @description The rendering mode. Can be either `markdown` or `gfm`. + * @description The rendering mode. * @default markdown * @example markdown * @enum {string} @@ -20946,11 +20963,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -21310,7 +21327,7 @@ export interface operations { org: components["parameters"]["org"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -27812,7 +27829,11 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.2/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ "repos/create-or-update-file-contents": { parameters: { path: { @@ -27882,6 +27903,8 @@ export interface operations { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.2/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -28659,7 +28682,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ + /** The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -29771,7 +29794,7 @@ export interface operations { query: { /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ milestone?: string; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; @@ -29781,7 +29804,7 @@ export interface operations { mentioned?: string; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -31595,7 +31618,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -31668,9 +31691,9 @@ export interface operations { head?: string; /** Filter pulls by base branch name. Example: `gh-pages`. */ base?: string; - /** What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). */ + /** What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. */ sort?: "created" | "updated" | "popularity" | "long-running"; - /** The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ + /** The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -31754,7 +31777,7 @@ export interface operations { }; query: { sort?: "created" | "updated" | "created_at"; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -32053,7 +32076,7 @@ export interface operations { query: { /** The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort"]; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -36110,11 +36133,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -36233,7 +36256,7 @@ export interface operations { "orgs/list-memberships-for-authenticated-user": { parameters: { query: { - /** Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. */ + /** Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -37137,7 +37160,7 @@ export interface operations { username: components["parameters"]["username"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; diff --git a/packages/openapi-types-ghes-3.3/package.json b/packages/openapi-types-ghes-3.3/package.json index 928d2a56f..03ea389b9 100644 --- a/packages/openapi-types-ghes-3.3/package.json +++ b/packages/openapi-types-ghes-3.3/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.12.0" + "openapi-version": "7.13.0" } } diff --git a/packages/openapi-types-ghes-3.3/types.d.ts b/packages/openapi-types-ghes-3.3/types.d.ts index 8305ee91c..d880b3200 100644 --- a/packages/openapi-types-ghes-3.3/types.d.ts +++ b/packages/openapi-types-ghes-3.3/types.d.ts @@ -2792,7 +2792,11 @@ export interface paths { * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ get: operations["repos/get-content"]; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.3/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ put: operations["repos/create-or-update-file-contents"]; /** * Deletes a file in a repository. @@ -2802,6 +2806,8 @@ export interface paths { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.3/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -8806,7 +8812,7 @@ export interface components { */ "alert-html-url": string; /** - * @description Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. + * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. * @enum {string} */ "secret-scanning-alert-state": "open" | "resolved"; @@ -10383,8 +10389,19 @@ export interface components { /** * @description The outcome of the job. * @example success + * @enum {string|null} */ - conclusion: string | null; + conclusion: + | ( + | "success" + | "failure" + | "neutral" + | "cancelled" + | "skipped" + | "timed_out" + | "action_required" + ) + | null; /** * Format: date-time * @description The time that the job started, in ISO 8601 format. @@ -16263,7 +16280,7 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** Response if the repository is archived or if github advanced security is not enabled for this repository */ + /** Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { content: { "application/json": components["schemas"]["basic-error"]; @@ -19727,11 +19744,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -19818,7 +19835,7 @@ export interface operations { /** @description The Markdown text to render in HTML. */ text: string; /** - * @description The rendering mode. Can be either `markdown` or `gfm`. + * @description The rendering mode. * @default markdown * @example markdown * @enum {string} @@ -21621,11 +21638,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -21985,7 +22002,7 @@ export interface operations { org: components["parameters"]["org"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -28681,7 +28698,11 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.3/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ "repos/create-or-update-file-contents": { parameters: { path: { @@ -28751,6 +28772,8 @@ export interface operations { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.3/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -29519,7 +29542,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ + /** The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -30631,7 +30654,7 @@ export interface operations { query: { /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ milestone?: string; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; @@ -30641,7 +30664,7 @@ export interface operations { mentioned?: string; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -32521,7 +32544,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -32594,9 +32617,9 @@ export interface operations { head?: string; /** Filter pulls by base branch name. Example: `gh-pages`. */ base?: string; - /** What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). */ + /** What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. */ sort?: "created" | "updated" | "popularity" | "long-running"; - /** The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ + /** The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -32680,7 +32703,7 @@ export interface operations { }; query: { sort?: "created" | "updated" | "created_at"; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -32979,7 +33002,7 @@ export interface operations { query: { /** The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort"]; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -37102,11 +37125,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -37225,7 +37248,7 @@ export interface operations { "orgs/list-memberships-for-authenticated-user": { parameters: { query: { - /** Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. */ + /** Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -38134,7 +38157,7 @@ export interface operations { username: components["parameters"]["username"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; diff --git a/packages/openapi-types-ghes-3.4/package.json b/packages/openapi-types-ghes-3.4/package.json index 549452db6..02dcbd2ce 100644 --- a/packages/openapi-types-ghes-3.4/package.json +++ b/packages/openapi-types-ghes-3.4/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.12.0" + "openapi-version": "7.13.0" } } diff --git a/packages/openapi-types-ghes-3.4/types.d.ts b/packages/openapi-types-ghes-3.4/types.d.ts index acae2febb..c18ed40be 100644 --- a/packages/openapi-types-ghes-3.4/types.d.ts +++ b/packages/openapi-types-ghes-3.4/types.d.ts @@ -3043,7 +3043,11 @@ export interface paths { * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ get: operations["repos/get-content"]; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.4/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ put: operations["repos/create-or-update-file-contents"]; /** * Deletes a file in a repository. @@ -3053,6 +3057,8 @@ export interface paths { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.4/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -7205,7 +7211,7 @@ export interface components { */ "alert-html-url": string; /** - * @description Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. + * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. * @enum {string} */ "secret-scanning-alert-state": "open" | "resolved"; @@ -10774,8 +10780,19 @@ export interface components { /** * @description The outcome of the job. * @example success + * @enum {string|null} */ - conclusion: string | null; + conclusion: + | ( + | "success" + | "failure" + | "neutral" + | "cancelled" + | "skipped" + | "timed_out" + | "action_required" + ) + | null; /** * Format: date-time * @description The time that the job started, in ISO 8601 format. @@ -16697,7 +16714,7 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** Response if the repository is archived or if github advanced security is not enabled for this repository */ + /** Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { content: { "application/json": components["schemas"]["basic-error"]; @@ -20290,11 +20307,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -20381,7 +20398,7 @@ export interface operations { /** @description The Markdown text to render in HTML. */ text: string; /** - * @description The rendering mode. Can be either `markdown` or `gfm`. + * @description The rendering mode. * @default markdown * @example markdown * @enum {string} @@ -22632,11 +22649,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -23129,7 +23146,7 @@ export interface operations { org: components["parameters"]["org"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -29976,7 +29993,11 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.4/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ "repos/create-or-update-file-contents": { parameters: { path: { @@ -30046,6 +30067,8 @@ export interface operations { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.4/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -31009,7 +31032,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ + /** The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -32121,7 +32144,7 @@ export interface operations { query: { /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ milestone?: string; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; @@ -32131,7 +32154,7 @@ export interface operations { mentioned?: string; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -34011,7 +34034,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -34084,9 +34107,9 @@ export interface operations { head?: string; /** Filter pulls by base branch name. Example: `gh-pages`. */ base?: string; - /** What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). */ + /** What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. */ sort?: "created" | "updated" | "popularity" | "long-running"; - /** The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ + /** The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -34170,7 +34193,7 @@ export interface operations { }; query: { sort?: "created" | "updated" | "created_at"; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -34469,7 +34492,7 @@ export interface operations { query: { /** The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort"]; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -38629,11 +38652,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -38752,7 +38775,7 @@ export interface operations { "orgs/list-memberships-for-authenticated-user": { parameters: { query: { - /** Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. */ + /** Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -39813,7 +39836,7 @@ export interface operations { username: components["parameters"]["username"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; diff --git a/packages/openapi-types-ghes-3.5/package.json b/packages/openapi-types-ghes-3.5/package.json index f11576578..bb1d74a11 100644 --- a/packages/openapi-types-ghes-3.5/package.json +++ b/packages/openapi-types-ghes-3.5/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.12.0" + "openapi-version": "7.13.0" } } diff --git a/packages/openapi-types-ghes-3.5/types.d.ts b/packages/openapi-types-ghes-3.5/types.d.ts index 5cd811f21..d24e04101 100644 --- a/packages/openapi-types-ghes-3.5/types.d.ts +++ b/packages/openapi-types-ghes-3.5/types.d.ts @@ -3181,7 +3181,11 @@ export interface paths { * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ get: operations["repos/get-content"]; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.5/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ put: operations["repos/create-or-update-file-contents"]; /** * Deletes a file in a repository. @@ -3191,6 +3195,8 @@ export interface paths { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.5/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -5319,6 +5325,22 @@ export interface paths { /** This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6 */ put: operations["actions/set-github-actions-default-workflow-permissions-enterprise"]; }; + "/orgs/{org}/external-group/{group_id}": { + /** This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6 */ + get: operations["teams/external-idp-group-info-for-org"]; + }; + "/orgs/{org}/external-groups": { + /** This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6 */ + get: operations["teams/list-external-idp-groups-for-org"]; + }; + "/orgs/{org}/teams/{team_slug}/external-groups": { + /** This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6 */ + get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; + /** This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6 */ + delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; + /** This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6 */ + patch: operations["teams/link-external-idp-group-to-team-for-org"]; + }; "/repos/{owner}/{repo}/actions/permissions/workflow": { /** This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6 */ get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; @@ -7343,7 +7365,7 @@ export interface components { */ "alert-html-url": string; /** - * @description Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. + * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. * @enum {string} */ "secret-scanning-alert-state": "open" | "resolved"; @@ -11110,8 +11132,19 @@ export interface components { /** * @description The outcome of the job. * @example success + * @enum {string|null} */ - conclusion: string | null; + conclusion: + | ( + | "success" + | "failure" + | "neutral" + | "cancelled" + | "skipped" + | "timed_out" + | "action_required" + ) + | null; /** * Format: date-time * @description The time that the job started, in ISO 8601 format. @@ -17018,7 +17051,7 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** Response if the repository is archived or if github advanced security is not enabled for this repository */ + /** Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { content: { "application/json": components["schemas"]["basic-error"]; @@ -20697,11 +20730,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -20788,7 +20821,7 @@ export interface operations { /** @description The Markdown text to render in HTML. */ text: string; /** - * @description The rendering mode. Can be either `markdown` or `gfm`. + * @description The rendering mode. * @default markdown * @example markdown * @enum {string} @@ -23202,11 +23235,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -23699,7 +23732,7 @@ export interface operations { org: components["parameters"]["org"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -30824,7 +30857,11 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.5/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ "repos/create-or-update-file-contents": { parameters: { path: { @@ -30894,6 +30931,8 @@ export interface operations { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.5/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -31857,7 +31896,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ + /** The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -32969,7 +33008,7 @@ export interface operations { query: { /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ milestone?: string; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; @@ -32979,7 +33018,7 @@ export interface operations { mentioned?: string; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -34859,7 +34898,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -34932,9 +34971,9 @@ export interface operations { head?: string; /** Filter pulls by base branch name. Example: `gh-pages`. */ base?: string; - /** What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). */ + /** What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. */ sort?: "created" | "updated" | "popularity" | "long-running"; - /** The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ + /** The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -35018,7 +35057,7 @@ export interface operations { }; query: { sort?: "created" | "updated" | "created_at"; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -35317,7 +35356,7 @@ export interface operations { query: { /** The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort"]; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -39564,11 +39603,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -39687,7 +39726,7 @@ export interface operations { "orgs/list-memberships-for-authenticated-user": { parameters: { query: { - /** Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. */ + /** Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -40748,7 +40787,7 @@ export interface operations { username: components["parameters"]["username"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -41071,6 +41110,41 @@ export interface operations { }; }; /** This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6 */ + "teams/external-idp-group-info-for-org": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6 */ + "teams/list-external-idp-groups-for-org": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6 */ + "teams/list-linked-external-idp-groups-to-team-for-org": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6 */ + "teams/unlink-external-idp-group-from-team-for-org": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6 */ + "teams/link-external-idp-group-to-team-for-org": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in 3.6 */ "actions/get-github-actions-default-workflow-permissions-repository": { responses: { /** Not Implemented */ diff --git a/packages/openapi-types-ghes-3.6/package.json b/packages/openapi-types-ghes-3.6/package.json index a9652a1e5..684745936 100644 --- a/packages/openapi-types-ghes-3.6/package.json +++ b/packages/openapi-types-ghes-3.6/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.12.0" + "openapi-version": "7.13.0" } } diff --git a/packages/openapi-types-ghes-3.6/types.d.ts b/packages/openapi-types-ghes-3.6/types.d.ts index 18026d4d7..6b6e765c4 100644 --- a/packages/openapi-types-ghes-3.6/types.d.ts +++ b/packages/openapi-types-ghes-3.6/types.d.ts @@ -1404,6 +1404,22 @@ export interface paths { "/orgs/{org}/events": { get: operations["activity/list-public-org-events"]; }; + "/orgs/{org}/external-group/{group_id}": { + /** + * Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. + * + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + */ + get: operations["teams/external-idp-group-info-for-org"]; + }; + "/orgs/{org}/external-groups": { + /** + * Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." + * + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + */ + get: operations["teams/list-external-idp-groups-for-org"]; + }; "/orgs/{org}/hooks": { get: operations["orgs/list-webhooks"]; /** Here's how you can create a hook that posts payloads in JSON format: */ @@ -1746,6 +1762,26 @@ export interface paths { */ delete: operations["reactions/delete-for-team-discussion"]; }; + "/orgs/{org}/teams/{team_slug}/external-groups": { + /** + * Lists a connection between a team and an external group. + * + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + */ + get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; + /** + * Deletes a connection between a team and an external group. + * + * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; + /** + * Creates a connection between a team and an external group. Only one external group can be linked to a team. + * + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + */ + patch: operations["teams/link-external-idp-group-to-team-for-org"]; + }; "/orgs/{org}/teams/{team_slug}/members": { /** * Team members will include the members of child teams. @@ -3225,7 +3261,11 @@ export interface paths { * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ get: operations["repos/get-content"]; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.6/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ put: operations["repos/create-or-update-file-contents"]; /** * Deletes a file in a repository. @@ -3235,6 +3275,8 @@ export interface paths { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.6/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -5457,14 +5499,6 @@ export interface paths { /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ patch: operations["orgs/update-custom-role"]; }; - "/orgs/{org}/external-group/{group_id}": { - /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ - get: operations["teams/external-idp-group-info-for-org"]; - }; - "/orgs/{org}/external-groups": { - /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ - get: operations["teams/list-external-idp-groups-for-org"]; - }; "/orgs/{org}/failed_invitations": { /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ get: operations["orgs/list-failed-invitations"]; @@ -5571,14 +5605,6 @@ export interface paths { /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ get: operations["teams/list-idp-groups-for-org"]; }; - "/orgs/{org}/teams/{team_slug}/external-groups": { - /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ - get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; - /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ - delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; - /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ - patch: operations["teams/link-external-idp-group-to-team-for-org"]; - }; "/orgs/{org}/teams/{team_slug}/invitations": { /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ get: operations["teams/list-pending-invitations-in-org"]; @@ -5627,6 +5653,14 @@ export interface paths { /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ delete: operations["repos/disable-automated-security-fixes"]; }; + "/repos/{owner}/{repo}/code-scanning/codeql/databases": { + /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ + get: operations["code-scanning/list-codeql-databases"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { + /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ + get: operations["code-scanning/get-codeql-database"]; + }; "/repos/{owner}/{repo}/codespaces": { /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ get: operations["codespaces/list-in-repository-for-authenticated-user"]; @@ -8092,7 +8126,7 @@ export interface components { */ "alert-html-url": string; /** - * @description Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. + * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. * @enum {string} */ "secret-scanning-alert-state": "open" | "resolved"; @@ -10423,6 +10457,129 @@ export interface components { */ key: string; }; + /** + * ExternalGroup + * @description Information about an external group's usage and its members + */ + "external-group": { + /** + * @description The internal ID of the group + * @example 1 + */ + group_id: number; + /** + * @description The display name for the group + * @example group-azuread-test + */ + group_name: string; + /** + * @description The date when the group was last updated_at + * @example 2021-01-03 22:27:15:000 -700 + */ + updated_at?: string; + /** + * @description An array of teams linked to this group + * @example [ + * { + * "team_id": 1, + * "team_name": "team-test" + * }, + * { + * "team_id": 2, + * "team_name": "team-test2" + * } + * ] + */ + teams: { + /** + * @description The id for a team + * @example 1 + */ + team_id: number; + /** + * @description The name of the team + * @example team-test + */ + team_name: string; + }[]; + /** + * @description An array of external members linked to this group + * @example [ + * { + * "member_id": 1, + * "member_login": "mona-lisa_eocsaxrs", + * "member_name": "Mona Lisa", + * "member_email": "mona_lisa@github.com" + * }, + * { + * "member_id": 2, + * "member_login": "octo-lisa_eocsaxrs", + * "member_name": "Octo Lisa", + * "member_email": "octo_lisa@github.com" + * } + * ] + */ + members: { + /** + * @description The internal user ID of the identity + * @example 1 + */ + member_id: number; + /** + * @description The handle/login for the user + * @example mona-lisa_eocsaxrs + */ + member_login: string; + /** + * @description The user display name/profile name + * @example Mona Lisa + */ + member_name: string; + /** + * @description An email attached to a user + * @example mona_lisa@github.com + */ + member_email: string; + }[]; + }; + /** + * ExternalGroups + * @description A list of external groups available to be connected to a team + */ + "external-groups": { + /** + * @description An array of external groups available to be mapped to a team + * @example [ + * { + * "group_id": 1, + * "group_name": "group-azuread-test", + * "updated_at": "2021-01-03 22:27:15:000 -700" + * }, + * { + * "group_id": 2, + * "group_name": "group-azuread-test2", + * "updated_at": "2021-06-03 22:27:15:000 -700" + * } + * ] + */ + groups?: { + /** + * @description The internal ID of the group + * @example 1 + */ + group_id: number; + /** + * @description The display name of the group + * @example group-azuread-test + */ + group_name: string; + /** + * @description The time of the last update for this group + * @example 2019-06-03 22:27:15:000 -700 + */ + updated_at: string; + }[]; + }; /** * Org Hook * @description Org Hook @@ -11989,8 +12146,19 @@ export interface components { /** * @description The outcome of the job. * @example success + * @enum {string|null} */ - conclusion: string | null; + conclusion: + | ( + | "success" + | "failure" + | "neutral" + | "cancelled" + | "skipped" + | "timed_out" + | "action_required" + ) + | null; /** * Format: date-time * @description The time that the job started, in ISO 8601 format. @@ -17964,7 +18132,7 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** Response if the repository is archived or if github advanced security is not enabled for this repository */ + /** Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { content: { "application/json": components["schemas"]["basic-error"]; @@ -18094,6 +18262,8 @@ export interface components { "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description The unique identifier of the group. */ + "group-id": number; /** @description The unique identifier of the migration. */ "migration-id": number; /** @description The slug of the team name. */ @@ -21705,11 +21875,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -21796,7 +21966,7 @@ export interface operations { /** @description The Markdown text to render in HTML. */ text: string; /** - * @description The rendering mode. Can be either `markdown` or `gfm`. + * @description The rendering mode. * @default markdown * @example markdown * @enum {string} @@ -23848,6 +24018,61 @@ export interface operations { }; }; }; + /** + * Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. + * + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + */ + "teams/external-idp-group-info-for-org": { + parameters: { + path: { + /** The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** The unique identifier of the group. */ + group_id: components["parameters"]["group-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["external-group"]; + }; + }; + }; + }; + /** + * Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." + * + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + */ + "teams/list-external-idp-groups-for-org": { + parameters: { + path: { + /** The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + query: { + /** The number of results per page (max 100). */ + per_page?: components["parameters"]["per-page"]; + /** Page token */ + page?: number; + /** Limits the list to groups containing the text in the group name */ + display_name?: string; + }; + }; + responses: { + /** Response */ + 200: { + headers: { + Link?: string; + }; + content: { + "application/json": components["schemas"]["external-groups"]; + }; + }; + }; + }; "orgs/list-webhooks": { parameters: { path: { @@ -24217,11 +24442,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -24714,7 +24939,7 @@ export interface operations { org: components["parameters"]["org"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -25837,6 +26062,82 @@ export interface operations { 204: never; }; }; + /** + * Lists a connection between a team and an external group. + * + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + */ + "teams/list-linked-external-idp-groups-to-team-for-org": { + parameters: { + path: { + /** The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["external-groups"]; + }; + }; + }; + }; + /** + * Deletes a connection between a team and an external group. + * + * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + "teams/unlink-external-idp-group-from-team-for-org": { + parameters: { + path: { + /** The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Creates a connection between a team and an external group. Only one external group can be linked to a team. + * + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + */ + "teams/link-external-idp-group-to-team-for-org": { + parameters: { + path: { + /** The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["external-group"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description External Group Id + * @example 1 + */ + group_id: number; + }; + }; + }; + }; /** * Team members will include the members of child teams. * @@ -31927,7 +32228,11 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.6/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ "repos/create-or-update-file-contents": { parameters: { path: { @@ -31997,6 +32302,8 @@ export interface operations { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.6/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -32988,7 +33295,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ + /** The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -34100,7 +34407,7 @@ export interface operations { query: { /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ milestone?: string; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; @@ -34110,7 +34417,7 @@ export interface operations { mentioned?: string; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -35990,7 +36297,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -36063,9 +36370,9 @@ export interface operations { head?: string; /** Filter pulls by base branch name. Example: `gh-pages`. */ base?: string; - /** What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). */ + /** What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. */ sort?: "created" | "updated" | "popularity" | "long-running"; - /** The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ + /** The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -36149,7 +36456,7 @@ export interface operations { }; query: { sort?: "created" | "updated" | "created_at"; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -36448,7 +36755,7 @@ export interface operations { query: { /** The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort"]; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -40701,11 +41008,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -40824,7 +41131,7 @@ export interface operations { "orgs/list-memberships-for-authenticated-user": { parameters: { query: { - /** Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. */ + /** Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -41885,7 +42192,7 @@ export interface operations { username: components["parameters"]["username"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -42376,20 +42683,6 @@ export interface operations { }; }; /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ - "teams/external-idp-group-info-for-org": { - responses: { - /** Not Implemented */ - 501: unknown; - }; - }; - /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ - "teams/list-external-idp-groups-for-org": { - responses: { - /** Not Implemented */ - 501: unknown; - }; - }; - /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ "orgs/list-failed-invitations": { responses: { /** Not Implemented */ @@ -42600,27 +42893,6 @@ export interface operations { }; }; /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ - "teams/list-linked-external-idp-groups-to-team-for-org": { - responses: { - /** Not Implemented */ - 501: unknown; - }; - }; - /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ - "teams/unlink-external-idp-group-from-team-for-org": { - responses: { - /** Not Implemented */ - 501: unknown; - }; - }; - /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ - "teams/link-external-idp-group-to-team-for-org": { - responses: { - /** Not Implemented */ - 501: unknown; - }; - }; - /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ "teams/list-pending-invitations-in-org": { responses: { /** Not Implemented */ @@ -42719,6 +42991,20 @@ export interface operations { }; }; /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ + "code-scanning/list-codeql-databases": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ + "code-scanning/get-codeql-database": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ "codespaces/list-in-repository-for-authenticated-user": { responses: { /** Not Implemented */ diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json index 10fbbdbae..5d3e16de5 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": "7.12.0" + "openapi-version": "7.13.0" } } diff --git a/packages/openapi-types-github.ae/types.d.ts b/packages/openapi-types-github.ae/types.d.ts index 4ee23d6d9..cd58287df 100644 --- a/packages/openapi-types-github.ae/types.d.ts +++ b/packages/openapi-types-github.ae/types.d.ts @@ -2584,7 +2584,11 @@ export interface paths { * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ get: operations["repos/get-content"]; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/github-ae@latest/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ put: operations["repos/create-or-update-file-contents"]; /** * Deletes a file in a repository. @@ -2594,6 +2598,8 @@ export interface paths { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/github-ae@latest/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -4817,6 +4823,14 @@ export interface paths { /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ post: operations["repos/rename-branch"]; }; + "/repos/{owner}/{repo}/code-scanning/codeql/databases": { + /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ + get: operations["code-scanning/list-codeql-databases"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { + /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ + get: operations["code-scanning/get-codeql-database"]; + }; "/repos/{owner}/{repo}/codespaces": { /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ get: operations["codespaces/list-in-repository-for-authenticated-user"]; @@ -10382,8 +10396,19 @@ export interface components { /** * @description The outcome of the job. * @example success + * @enum {string|null} */ - conclusion: string | null; + conclusion: + | ( + | "success" + | "failure" + | "neutral" + | "cancelled" + | "skipped" + | "timed_out" + | "action_required" + ) + | null; /** * Format: date-time * @description The time that the job started, in ISO 8601 format. @@ -15303,7 +15328,7 @@ export interface components { */ "alert-updated-at": string; /** - * @description Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. + * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. * @enum {string} */ "secret-scanning-alert-state": "open" | "resolved"; @@ -16235,7 +16260,7 @@ export interface components { }; }; }; - /** Response if the repository is archived or if github advanced security is not enabled for this repository */ + /** Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { content: { "application/json": components["schemas"]["basic-error"]; @@ -18836,11 +18861,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -18927,7 +18952,7 @@ export interface operations { /** @description The Markdown text to render in HTML. */ text: string; /** - * @description The rendering mode. Can be either `markdown` or `gfm`. + * @description The rendering mode. * @default markdown * @example markdown * @enum {string} @@ -20633,11 +20658,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -21037,7 +21062,7 @@ export interface operations { org: components["parameters"]["org"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -27648,7 +27673,11 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/github-ae@latest/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ "repos/create-or-update-file-contents": { parameters: { path: { @@ -27718,6 +27747,8 @@ export interface operations { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/github-ae@latest/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -28486,7 +28517,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ + /** The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -29598,7 +29629,7 @@ export interface operations { query: { /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ milestone?: string; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; @@ -29608,7 +29639,7 @@ export interface operations { mentioned?: string; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -31383,7 +31414,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -31456,9 +31487,9 @@ export interface operations { head?: string; /** Filter pulls by base branch name. Example: `gh-pages`. */ base?: string; - /** What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). */ + /** What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. */ sort?: "created" | "updated" | "popularity" | "long-running"; - /** The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ + /** The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -31542,7 +31573,7 @@ export interface operations { }; query: { sort?: "created" | "updated" | "created_at"; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -31841,7 +31872,7 @@ export interface operations { query: { /** The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort"]; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -35400,11 +35431,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -35523,7 +35554,7 @@ export interface operations { "orgs/list-memberships-for-authenticated-user": { parameters: { query: { - /** Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. */ + /** Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -36538,7 +36569,7 @@ export interface operations { username: components["parameters"]["username"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -37714,6 +37745,20 @@ export interface operations { }; }; /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ + "code-scanning/list-codeql-databases": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ + "code-scanning/get-codeql-database": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ "codespaces/list-in-repository-for-authenticated-user": { responses: { /** Not Implemented */ diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json index 50082c853..dad180a82 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": "7.12.0" + "openapi-version": "7.13.0" } } diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index b249e6102..a93f2fde3 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -3239,6 +3239,32 @@ export interface paths { */ delete: operations["code-scanning/delete-analysis"]; }; + "/repos/{owner}/{repo}/code-scanning/codeql/databases": { + /** + * Lists the CodeQL databases that are available in a repository. + * + * For private repositories, you must use an access token with the `security_events` scope. + * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + * GitHub Apps must have the `contents` read permission to use this endpoint. + */ + get: operations["code-scanning/list-codeql-databases"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { + /** + * Gets a CodeQL database for a language in a repository. + * + * By default this endpoint returns JSON metadata about the CodeQL database. To + * download the CodeQL database binary content, set the `Accept` header of the request + * to [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure + * your HTTP client is configured to follow redirects or use the `Location` header + * to make a second request to get the redirect URL. + * + * For private repositories, you must use an access token with the `security_events` scope. + * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + * GitHub Apps must have the `contents` read permission to use this endpoint. + */ + get: operations["code-scanning/get-codeql-database"]; + }; "/repos/{owner}/{repo}/code-scanning/sarifs": { /** * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. @@ -3733,7 +3759,11 @@ export interface paths { * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ get: operations["repos/get-content"]; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ put: operations["repos/create-or-update-file-contents"]; /** * Deletes a file in a repository. @@ -3743,6 +3773,8 @@ export interface paths { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -8791,7 +8823,7 @@ export interface components { */ "nullable-alert-updated-at": string | null; /** - * @description Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. + * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. * @enum {string} */ "secret-scanning-alert-state": "open" | "resolved"; @@ -13473,8 +13505,19 @@ export interface components { /** * @description The outcome of the job. * @example success + * @enum {string|null} */ - conclusion: string | null; + conclusion: + | ( + | "success" + | "failure" + | "neutral" + | "cancelled" + | "skipped" + | "timed_out" + | "action_required" + ) + | null; /** * Format: date-time * @description The time that the job started, in ISO 8601 format. @@ -14904,6 +14947,38 @@ export interface components { */ confirm_delete_url: string | null; }; + /** + * CodeQL Database + * @description A CodeQL database. + */ + "code-scanning-codeql-database": { + /** @description The ID of the CodeQL database. */ + id: number; + /** @description The name of the CodeQL database. */ + name: string; + /** @description The language of the CodeQL database. */ + language: string; + uploader: components["schemas"]["simple-user"]; + /** @description The MIME type of the CodeQL database file. */ + content_type: string; + /** @description The size of the CodeQL database file in bytes. */ + size: number; + /** + * Format: date-time + * @description The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + created_at: string; + /** + * Format: date-time + * @description The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + updated_at: string; + /** + * Format: uri + * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. + */ + url: string; + }; /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */ "code-scanning-analysis-sarif-file": string; "code-scanning-sarifs-receipt": { @@ -20153,7 +20228,7 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** Response if the repository is archived or if github advanced security is not enabled for this repository */ + /** Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { content: { "application/json": components["schemas"]["basic-error"]; @@ -22893,11 +22968,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -22984,7 +23059,7 @@ export interface operations { /** @description The Markdown text to render in HTML. */ text: string; /** - * @description The rendering mode. Can be either `markdown` or `gfm`. + * @description The rendering mode. * @default markdown * @example markdown * @enum {string} @@ -26270,11 +26345,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -27053,7 +27128,7 @@ export interface operations { org: components["parameters"]["org"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -33801,6 +33876,71 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Lists the CodeQL databases that are available in a repository. + * + * For private repositories, you must use an access token with the `security_events` scope. + * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + * GitHub Apps must have the `contents` read permission to use this endpoint. + */ + "code-scanning/list-codeql-databases": { + parameters: { + path: { + /** The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** The name of the repository. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-codeql-database"][]; + }; + }; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Gets a CodeQL database for a language in a repository. + * + * By default this endpoint returns JSON metadata about the CodeQL database. To + * download the CodeQL database binary content, set the `Accept` header of the request + * to [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure + * your HTTP client is configured to follow redirects or use the `Location` header + * to make a second request to get the redirect URL. + * + * For private repositories, you must use an access token with the `security_events` scope. + * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + * GitHub Apps must have the `contents` read permission to use this endpoint. + */ + "code-scanning/get-codeql-database": { + parameters: { + path: { + /** The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** The name of the repository. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** The language of the CodeQL database. */ + language: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-codeql-database"]; + }; + }; + 302: components["responses"]["found"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. * @@ -35302,7 +35442,11 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. */ + /** + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + */ "repos/create-or-update-file-contents": { parameters: { path: { @@ -35372,6 +35516,8 @@ export interface operations { * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -36396,7 +36542,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ + /** The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -37847,7 +37993,7 @@ export interface operations { query: { /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ milestone?: string; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; @@ -37857,7 +38003,7 @@ export interface operations { mentioned?: string; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -39714,7 +39860,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -39787,9 +39933,9 @@ export interface operations { head?: string; /** Filter pulls by base branch name. Example: `gh-pages`. */ base?: string; - /** What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). */ + /** What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. */ sort?: "created" | "updated" | "popularity" | "long-running"; - /** The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ + /** The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -39873,7 +40019,7 @@ export interface operations { }; query: { sort?: "created" | "updated" | "created_at"; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -40232,7 +40378,7 @@ export interface operations { query: { /** The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort"]; - /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + /** The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -46028,11 +46174,11 @@ export interface operations { | "subscribed" | "repos" | "all"; - /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; - /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + /** What to sort results by. */ sort?: "created" | "updated" | "comments"; /** The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -46196,7 +46342,7 @@ export interface operations { "orgs/list-memberships-for-authenticated-user": { parameters: { query: { - /** Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. */ + /** Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"]; @@ -47878,7 +48024,7 @@ export interface operations { username: components["parameters"]["username"]; }; query: { - /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + /** Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; /** The number of results per page (max 100). */ per_page?: components["parameters"]["per-page"];