From 032e20f29f3de6408dfe3de41154e29df58f0a81 Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Fri, 5 May 2023 13:32:58 -0500 Subject: [PATCH] fix: update the types for the patch to fix occurences of `never` (#309) --- cache/api.github.com.json | 65 +--- cache/ghec.json | 71 ++-- cache/ghes-3.5.json | 79 ++--- cache/ghes-3.6.json | 79 ++--- cache/ghes-3.7.json | 71 ++-- cache/ghes-3.8.json | 79 ++--- cache/github.ae.json | 79 ++--- packages/openapi-types-ghec/package.json | 2 +- packages/openapi-types-ghec/types.d.ts | 314 +++++++++--------- packages/openapi-types-ghes-3.5/package.json | 2 +- packages/openapi-types-ghes-3.5/types.d.ts | 254 +++++++------- packages/openapi-types-ghes-3.6/package.json | 2 +- packages/openapi-types-ghes-3.6/types.d.ts | 268 +++++++-------- packages/openapi-types-ghes-3.7/package.json | 2 +- packages/openapi-types-ghes-3.7/types.d.ts | 292 ++++++++-------- packages/openapi-types-ghes-3.8/package.json | 2 +- packages/openapi-types-ghes-3.8/types.d.ts | 312 +++++++++-------- packages/openapi-types-github.ae/package.json | 2 +- packages/openapi-types-github.ae/types.d.ts | 254 +++++++------- packages/openapi-types/package.json | 2 +- packages/openapi-types/types.d.ts | 290 ++++++++-------- 21 files changed, 1091 insertions(+), 1430 deletions(-) diff --git a/cache/api.github.com.json b/cache/api.github.com.json index b11dad541..6ce89ebaf 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "11.1.0", + "version": "11.1.1", "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": { @@ -2189,6 +2189,7 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { "description": { "description": "The description of the gist.", @@ -2205,29 +2206,20 @@ }, "type": "object", "additionalProperties": { - "type": "object", - "nullable": true, - "properties": { - "content": { - "description": "The new content of the file.", - "type": "string" - }, - "filename": { - "description": "The new filename for the file.", - "type": "string", - "nullable": true - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, + "oneOf": [ { - "required": [ - "filename" - ] + "type": "object", + "properties": { + "content": { + "description": "The new content of the file.", + "type": "string" + }, + "filename": { + "description": "The new filename for the file.", + "type": "string", + "nullable": true + } + } }, { "type": "object", @@ -2237,19 +2229,6 @@ } } }, - "anyOf": [ - { - "required": [ - "description" - ] - }, - { - "required": [ - "files" - ] - } - ], - "type": "object", "nullable": true }, "examples": { @@ -44086,19 +44065,7 @@ "type": "string" } } - }, - "anyOf": [ - { - "required": [ - "reviewers" - ] - }, - { - "required": [ - "team_reviewers" - ] - } - ] + } }, "examples": { "default": { diff --git a/cache/ghec.json b/cache/ghec.json index 125e08912..3dce9c35b 100644 --- a/cache/ghec.json +++ b/cache/ghec.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "11.1.0", + "version": "11.1.1", "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": { @@ -5182,7 +5182,7 @@ "operationId": "gists/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/gists/#update-a-gist" + "url": "https://docs.github.com/rest/reference/gists/#update-a-gist" }, "parameters": [ { @@ -5194,6 +5194,7 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { "description": { "description": "The description of the gist.", @@ -5210,29 +5211,20 @@ }, "type": "object", "additionalProperties": { - "type": "object", - "nullable": true, - "properties": { - "content": { - "description": "The new content of the file.", - "type": "string" - }, - "filename": { - "description": "The new filename for the file.", - "type": "string", - "nullable": true - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, + "oneOf": [ { - "required": [ - "filename" - ] + "type": "object", + "properties": { + "content": { + "description": "The new content of the file.", + "type": "string" + }, + "filename": { + "description": "The new filename for the file.", + "type": "string", + "nullable": true + } + } }, { "type": "object", @@ -5242,19 +5234,6 @@ } } }, - "anyOf": [ - { - "required": [ - "description" - ] - }, - { - "required": [ - "files" - ] - } - ], - "type": "object", "nullable": true }, "examples": { @@ -49600,14 +49579,14 @@ }, "post": { "summary": "Request reviewers for a pull request", - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], "operationId": "pulls/request-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#request-reviewers-for-a-pull-request" + "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request" }, "parameters": [ { @@ -49641,19 +49620,7 @@ "type": "string" } } - }, - "anyOf": [ - { - "required": [ - "reviewers" - ] - }, - { - "required": [ - "team_reviewers" - ] - } - ] + } }, "examples": { "default": { diff --git a/cache/ghes-3.5.json b/cache/ghes-3.5.json index 04a97ad26..c7db1a835 100644 --- a/cache/ghes-3.5.json +++ b/cache/ghes-3.5.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "11.1.0", + "version": "11.1.1", "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": { @@ -7651,7 +7651,7 @@ "operationId": "gists/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/gists/#update-a-gist" + "url": "https://docs.github.com/rest/reference/gists/#update-a-gist" }, "parameters": [ { @@ -7663,6 +7663,7 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { "description": { "description": "The description of the gist.", @@ -7679,29 +7680,20 @@ }, "type": "object", "additionalProperties": { - "type": "object", - "nullable": true, - "properties": { - "content": { - "description": "The new content of the file.", - "type": "string" - }, - "filename": { - "description": "The new filename for the file.", - "type": "string", - "nullable": true - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, + "oneOf": [ { - "required": [ - "filename" - ] + "type": "object", + "properties": { + "content": { + "description": "The new content of the file.", + "type": "string" + }, + "filename": { + "description": "The new filename for the file.", + "type": "string", + "nullable": true + } + } }, { "type": "object", @@ -7711,19 +7703,6 @@ } } }, - "anyOf": [ - { - "required": [ - "description" - ] - }, - { - "required": [ - "files" - ] - } - ], - "type": "object", "nullable": true }, "examples": { @@ -41485,14 +41464,14 @@ }, "post": { "summary": "Request reviewers for a pull request", - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.5/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], "operationId": "pulls/request-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#request-reviewers-for-a-pull-request" + "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request" }, "parameters": [ { @@ -41526,19 +41505,7 @@ "type": "string" } } - }, - "anyOf": [ - { - "required": [ - "reviewers" - ] - }, - { - "required": [ - "team_reviewers" - ] - } - ] + } }, "examples": { "default": { @@ -41587,13 +41554,7 @@ "category": "pulls", "subcategory": "review-requests" }, - "x-octokit": { - "diff": { - "ghes-3.6": { - "type": "changed" - } - } - } + "x-octokit": {} }, "delete": { "summary": "Remove requested reviewers from a pull request", diff --git a/cache/ghes-3.6.json b/cache/ghes-3.6.json index c5d50d016..b42bd9f88 100644 --- a/cache/ghes-3.6.json +++ b/cache/ghes-3.6.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "11.1.0", + "version": "11.1.1", "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": { @@ -7753,7 +7753,7 @@ "operationId": "gists/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/gists/#update-a-gist" + "url": "https://docs.github.com/rest/reference/gists/#update-a-gist" }, "parameters": [ { @@ -7765,6 +7765,7 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { "description": { "description": "The description of the gist.", @@ -7781,29 +7782,20 @@ }, "type": "object", "additionalProperties": { - "type": "object", - "nullable": true, - "properties": { - "content": { - "description": "The new content of the file.", - "type": "string" - }, - "filename": { - "description": "The new filename for the file.", - "type": "string", - "nullable": true - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, + "oneOf": [ { - "required": [ - "filename" - ] + "type": "object", + "properties": { + "content": { + "description": "The new content of the file.", + "type": "string" + }, + "filename": { + "description": "The new filename for the file.", + "type": "string", + "nullable": true + } + } }, { "type": "object", @@ -7813,19 +7805,6 @@ } } }, - "anyOf": [ - { - "required": [ - "description" - ] - }, - { - "required": [ - "files" - ] - } - ], - "type": "object", "nullable": true }, "examples": { @@ -42024,14 +42003,14 @@ }, "post": { "summary": "Request reviewers for a pull request", - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.6/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], "operationId": "pulls/request-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#request-reviewers-for-a-pull-request" + "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request" }, "parameters": [ { @@ -42065,19 +42044,7 @@ "type": "string" } } - }, - "anyOf": [ - { - "required": [ - "reviewers" - ] - }, - { - "required": [ - "team_reviewers" - ] - } - ] + } }, "examples": { "default": { @@ -42126,13 +42093,7 @@ "category": "pulls", "subcategory": "review-requests" }, - "x-octokit": { - "diff": { - "ghes-3.7": { - "type": "changed" - } - } - } + "x-octokit": {} }, "delete": { "summary": "Remove requested reviewers from a pull request", diff --git a/cache/ghes-3.7.json b/cache/ghes-3.7.json index 6d063d379..32f42d751 100644 --- a/cache/ghes-3.7.json +++ b/cache/ghes-3.7.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "11.1.0", + "version": "11.1.1", "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": { @@ -7912,7 +7912,7 @@ "operationId": "gists/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/gists/#update-a-gist" + "url": "https://docs.github.com/rest/reference/gists/#update-a-gist" }, "parameters": [ { @@ -7924,6 +7924,7 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { "description": { "description": "The description of the gist.", @@ -7940,29 +7941,20 @@ }, "type": "object", "additionalProperties": { - "type": "object", - "nullable": true, - "properties": { - "content": { - "description": "The new content of the file.", - "type": "string" - }, - "filename": { - "description": "The new filename for the file.", - "type": "string", - "nullable": true - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, + "oneOf": [ { - "required": [ - "filename" - ] + "type": "object", + "properties": { + "content": { + "description": "The new content of the file.", + "type": "string" + }, + "filename": { + "description": "The new filename for the file.", + "type": "string", + "nullable": true + } + } }, { "type": "object", @@ -7972,19 +7964,6 @@ } } }, - "anyOf": [ - { - "required": [ - "description" - ] - }, - { - "required": [ - "files" - ] - } - ], - "type": "object", "nullable": true }, "examples": { @@ -42898,14 +42877,14 @@ }, "post": { "summary": "Request reviewers for a pull request", - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.7/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.7/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], "operationId": "pulls/request-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/pulls#request-reviewers-for-a-pull-request" + "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request" }, "parameters": [ { @@ -42939,19 +42918,7 @@ "type": "string" } } - }, - "anyOf": [ - { - "required": [ - "reviewers" - ] - }, - { - "required": [ - "team_reviewers" - ] - } - ] + } }, "examples": { "default": { diff --git a/cache/ghes-3.8.json b/cache/ghes-3.8.json index 39a5a7856..bb3e410be 100644 --- a/cache/ghes-3.8.json +++ b/cache/ghes-3.8.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "11.1.0", + "version": "11.1.1", "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": { @@ -8709,7 +8709,7 @@ "operationId": "gists/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.8/rest/reference/gists/#update-a-gist" + "url": "https://docs.github.com/rest/reference/gists/#update-a-gist" }, "parameters": [ { @@ -8721,6 +8721,7 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { "description": { "description": "The description of the gist.", @@ -8737,29 +8738,20 @@ }, "type": "object", "additionalProperties": { - "type": "object", - "nullable": true, - "properties": { - "content": { - "description": "The new content of the file.", - "type": "string" - }, - "filename": { - "description": "The new filename for the file.", - "type": "string", - "nullable": true - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, + "oneOf": [ { - "required": [ - "filename" - ] + "type": "object", + "properties": { + "content": { + "description": "The new content of the file.", + "type": "string" + }, + "filename": { + "description": "The new filename for the file.", + "type": "string", + "nullable": true + } + } }, { "type": "object", @@ -8769,19 +8761,6 @@ } } }, - "anyOf": [ - { - "required": [ - "description" - ] - }, - { - "required": [ - "files" - ] - } - ], - "type": "object", "nullable": true }, "examples": { @@ -46142,14 +46121,14 @@ }, "post": { "summary": "Request reviewers for a pull request", - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.8/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.8/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], "operationId": "pulls/request-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.8/rest/reference/pulls#request-reviewers-for-a-pull-request" + "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request" }, "parameters": [ { @@ -46183,19 +46162,7 @@ "type": "string" } } - }, - "anyOf": [ - { - "required": [ - "reviewers" - ] - }, - { - "required": [ - "team_reviewers" - ] - } - ] + } }, "examples": { "default": { @@ -46244,13 +46211,7 @@ "category": "pulls", "subcategory": "review-requests" }, - "x-octokit": { - "diff": { - "api.github.com": { - "type": "changed" - } - } - } + "x-octokit": {} }, "delete": { "summary": "Remove requested reviewers from a pull request", diff --git a/cache/github.ae.json b/cache/github.ae.json index 45b2466e9..f0ebcbeca 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "11.1.0", + "version": "11.1.1", "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": { @@ -5616,7 +5616,7 @@ "operationId": "gists/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#update-a-gist" + "url": "https://docs.github.com/rest/reference/gists/#update-a-gist" }, "parameters": [ { @@ -5628,6 +5628,7 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { "description": { "description": "The description of the gist.", @@ -5644,29 +5645,20 @@ }, "type": "object", "additionalProperties": { - "type": "object", - "nullable": true, - "properties": { - "content": { - "description": "The new content of the file.", - "type": "string" - }, - "filename": { - "description": "The new filename for the file.", - "type": "string", - "nullable": true - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, + "oneOf": [ { - "required": [ - "filename" - ] + "type": "object", + "properties": { + "content": { + "description": "The new content of the file.", + "type": "string" + }, + "filename": { + "description": "The new filename for the file.", + "type": "string", + "nullable": true + } + } }, { "type": "object", @@ -5676,19 +5668,6 @@ } } }, - "anyOf": [ - { - "required": [ - "description" - ] - }, - { - "required": [ - "files" - ] - } - ], - "type": "object", "nullable": true }, "examples": { @@ -36734,14 +36713,14 @@ }, "post": { "summary": "Request reviewers for a pull request", - "description": "This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], "operationId": "pulls/request-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/pulls#request-reviewers-for-a-pull-request" + "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request" }, "parameters": [ { @@ -36775,19 +36754,7 @@ "type": "string" } } - }, - "anyOf": [ - { - "required": [ - "reviewers" - ] - }, - { - "required": [ - "team_reviewers" - ] - } - ] + } }, "examples": { "default": { @@ -36836,13 +36803,7 @@ "category": "pulls", "subcategory": "review-requests" }, - "x-octokit": { - "diff": { - "api.github.com": { - "type": "changed" - } - } - } + "x-octokit": {} }, "delete": { "summary": "Remove requested reviewers from a pull request", diff --git a/packages/openapi-types-ghec/package.json b/packages/openapi-types-ghec/package.json index df64dc21a..01de2a530 100644 --- a/packages/openapi-types-ghec/package.json +++ b/packages/openapi-types-ghec/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "11.1.0" + "openapi-version": "11.1.1" } } diff --git a/packages/openapi-types-ghec/types.d.ts b/packages/openapi-types-ghec/types.d.ts index d56d98163..185aadecd 100644 --- a/packages/openapi-types-ghec/types.d.ts +++ b/packages/openapi-types-ghec/types.d.ts @@ -6625,7 +6625,7 @@ export interface paths { get: operations["pulls/list-requested-reviewers"]; /** * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ post: operations["pulls/request-reviewers"]; /** Remove requested reviewers from a pull request */ @@ -9446,17 +9446,17 @@ export interface components { request: { /** @description The request headers sent with the webhook delivery. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The webhook payload. */ payload: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; }; response: { /** @description The response headers received when the delivery was made. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The response payload received. */ payload: string | null; @@ -10853,7 +10853,7 @@ export interface components { country_name?: string; }; data?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; org_id?: number; user_id?: number; @@ -12121,8 +12121,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; }; /** * Public User @@ -12270,8 +12270,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["nullable-simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; } | null; url?: string; forks_url?: string; @@ -17402,7 +17402,7 @@ export interface components { payload: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -23201,7 +23201,7 @@ export interface components { /** @enum {string} */ op: "add" | "remove" | "replace"; path?: string; - value?: string | Record | Record[]; + value?: string | Record | unknown[]; }[]; /** @description associated groups */ groups?: { @@ -24070,7 +24070,7 @@ export interface components { email?: string; verified?: boolean; }[]; - subkeys?: Record[]; + subkeys?: unknown[]; can_sign?: boolean; can_encrypt_comms?: boolean; can_encrypt_storage?: boolean; @@ -43913,7 +43913,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; npm_metadata?: { @@ -44171,7 +44171,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; package_files: { @@ -77211,7 +77211,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; npm_metadata?: { @@ -77407,7 +77407,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; package_files: { @@ -78748,7 +78748,7 @@ export interface components { action: string; branch: string; client_payload: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; enterprise?: components["schemas"]["enterprise"]; installation: components["schemas"]["simple-installation"]; @@ -82241,7 +82241,7 @@ export interface components { "webhook-workflow-dispatch": { enterprise?: components["schemas"]["enterprise"]; inputs: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple"]; @@ -84700,14 +84700,14 @@ export interface components { }; parameters: { /** @description The number of results per page (max 100). */ - "per-page": number; + "per-page"?: number; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor: string; + cursor?: string; "delivery-id": number; /** @description Page number of the results to fetch. */ - page: number; + page?: number; /** @description 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: string; + since?: string; /** @description The unique identifier of the installation. */ "installation-id": number; /** @description The client ID of the GitHub app. */ @@ -84720,7 +84720,7 @@ export interface components { /** @description The unique identifier of the organization. */ "org-id": number; /** @description Only return runner groups that are allowed to be used by this organization. */ - "visible-to-organization": string; + "visible-to-organization"?: string; /** @description Unique identifier of the self-hosted runner group. */ "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ @@ -84728,7 +84728,7 @@ export interface components { /** @description The name of a self-hosted runner's custom label. */ "runner-label-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ - "audit-log-enterprise-phrase": string; + "audit-log-enterprise-phrase"?: string; /** * @description The event types to include: * @@ -84738,79 +84738,79 @@ export interface components { * * The default is `web`. */ - "audit-log-include": "web" | "git" | "all"; + "audit-log-include"?: "web" | "git" | "all"; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ - "audit-log-after": string; + "audit-log-after"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ - "audit-log-before": string; + "audit-log-before"?: string; /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - "audit-log-order": "desc" | "asc"; + "audit-log-order"?: "desc" | "asc"; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + "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"]; + "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"]; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */ - "pagination-before": string; + "pagination-before"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */ - "pagination-after": string; + "pagination-after"?: string; /** @description The direction to sort the results by. */ - direction: "asc" | "desc"; + direction?: "asc" | "desc"; /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ - "dependabot-alert-comma-separated-states": string; + "dependabot-alert-comma-separated-states"?: string; /** * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * * Can be: `low`, `medium`, `high`, `critical` */ - "dependabot-alert-comma-separated-severities": string; + "dependabot-alert-comma-separated-severities"?: string; /** * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ - "dependabot-alert-comma-separated-ecosystems": string; + "dependabot-alert-comma-separated-ecosystems"?: string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - "dependabot-alert-comma-separated-packages": string; + "dependabot-alert-comma-separated-packages"?: string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - "dependabot-alert-scope": "development" | "runtime"; + "dependabot-alert-scope"?: "development" | "runtime"; /** * @description The property by which to sort the results. * `created` means when the alert was created. * `updated` means when the alert's state last changed. */ - "dependabot-alert-sort": "created" | "updated"; + "dependabot-alert-sort"?: "created" | "updated"; /** * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ - "pagination-first": number; + "pagination-first"?: number; /** * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. * This parameter must not be used in combination with `first`. * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ - "pagination-last": number; + "pagination-last"?: number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; + "secret-scanning-alert-state"?: "open" | "resolved"; /** * @description A comma-separated list of secret types to return. By default all secret types are returned. * See "[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" * for a complete list of secret types. */ - "secret-scanning-alert-secret-type": string; + "secret-scanning-alert-secret-type"?: string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; + "secret-scanning-alert-resolution"?: string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "secret-scanning-alert-sort": "created" | "updated"; + "secret-scanning-alert-sort"?: "created" | "updated"; /** @description The security feature to enable or disable. */ "enterprise-security-product": | "advanced_security" @@ -84829,41 +84829,41 @@ export interface components { /** @description The unique identifier of the comment. */ "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels: string; + labels?: string; /** @description account_id parameter */ "account-id": number; /** @description The unique identifier of the plan. */ "plan-id": number; /** @description The property to sort the results by. */ - sort: "created" | "updated"; + sort?: "created" | "updated"; /** @description The account owner of the repository. The name is not case sensitive. */ owner: string; /** @description The name of the repository. The name is not case sensitive. */ repo: string; /** @description If `true`, show notifications marked as read. */ - all: boolean; + all?: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating: boolean; + participating?: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before: string; + before?: string; /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org": number; + "since-org"?: number; /** @description The organization name. The name is not case sensitive. */ org: string; /** @description The property by which to sort the results. */ - "personal-access-token-sort": "created_at"; + "personal-access-token-sort"?: "created_at"; /** @description A list of owner usernames to use to filter the results. */ - "personal-access-token-owner": string[]; + "personal-access-token-owner"?: string[]; /** @description The name of the repository to use to filter the results. */ - "personal-access-token-repository": string; + "personal-access-token-repository"?: string; /** @description The permission to use to filter the results. */ - "personal-access-token-permission": string; + "personal-access-token-permission"?: string; /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "personal-access-token-before": string; + "personal-access-token-before"?: string; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "personal-access-token-after": string; + "personal-access-token-after"?: string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; /** @description The unique identifier of the repository. */ @@ -84871,15 +84871,15 @@ export interface components { /** @description The unique identifier of the required workflow. */ "required-workflow-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ - "visible-to-repository": string; + "visible-to-repository"?: string; /** @description The name of the secret. */ "secret-name": string; /** @description The number of results per page (max 30). */ - "variables-per-page": number; + "variables-per-page"?: number; /** @description The name of the variable. */ "variable-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase": string; + "audit-log-phrase"?: string; /** @description The handle for the GitHub user account. */ username: string; /** @description The unique identifier of the role. */ @@ -84902,7 +84902,7 @@ export interface components { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ - "package-visibility": "public" | "private" | "internal"; + "package-visibility"?: "public" | "private" | "internal"; /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ "package-type": | "npm" @@ -84916,9 +84916,9 @@ export interface components { /** @description Unique identifier of the package version. */ "package-version-id": number; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - "secret-scanning-pagination-before-org-repo": string; + "secret-scanning-pagination-before-org-repo"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - "secret-scanning-pagination-after-org-repo": string; + "secret-scanning-pagination-after-org-repo"?: string; /** @description The slug of the team name. */ "team-slug": string; /** @description The number that identifies the discussion. */ @@ -84954,11 +84954,11 @@ export interface components { /** @description The unique identifier of the artifact. */ "artifact-id": number; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - "actions-cache-git-ref-full": string; + "actions-cache-git-ref-full"?: string; /** @description An explicit key or prefix for identifying the cache */ - "actions-cache-key": string; + "actions-cache-key"?: string; /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ - "actions-cache-list-sort": + "actions-cache-list-sort"?: | "created_at" | "last_accessed_at" | "size_in_bytes"; @@ -84969,13 +84969,13 @@ export interface components { /** @description The unique identifier of the job. */ "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor: string; + actor?: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch": string; + "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-cloud@latest//actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event: string; + event?: string; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ - "workflow-run-status": + "workflow-run-status"?: | "completed" | "action_required" | "cancelled" @@ -84991,13 +84991,13 @@ export interface components { | "waiting" | "pending"; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created: string; + created?: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests": boolean; + "exclude-pull-requests"?: boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id": number; + "workflow-run-check-suite-id"?: number; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - "workflow-run-head-sha": string; + "workflow-run-head-sha"?: string; /** @description The unique identifier of the workflow run. */ "run-id": number; /** @description The attempt number of the workflow run. */ @@ -85013,17 +85013,17 @@ export interface components { /** @description The unique identifier of the check suite. */ "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - "check-name": string; + "check-name"?: string; /** @description Returns check runs with the specified `status`. */ - status: "queued" | "in_progress" | "completed"; + status?: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - "git-ref": components["schemas"]["code-scanning-ref"]; + "git-ref"?: components["schemas"]["code-scanning-ref"]; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ "commit-sha": string; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ - "dependabot-alert-comma-separated-manifests": string; + "dependabot-alert-comma-separated-manifests"?: string; /** * @description The number that identifies a Dependabot alert in its repository. * You can find this at the end of the URL for a Dependabot alert within GitHub, @@ -85032,7 +85032,7 @@ export interface components { */ "dependabot-alert-number": components["schemas"]["alert-number"]; /** @description The full path, relative to the repository root, of the dependency manifest file. */ - "manifest-path": string; + "manifest-path"?: string; /** @description deployment_id parameter */ "deployment-id": number; /** @description The name of the environment. */ @@ -85042,7 +85042,7 @@ export interface components { /** @description The unique identifier of the protection rule. */ "protection-rule-id": number; /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user": number; + "since-user"?: number; /** @description The number that identifies the issue. */ "issue-number": number; /** @description The unique identifier of the key. */ @@ -85062,29 +85062,29 @@ export interface components { /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description The time frame to display results for. */ - per: "day" | "week"; + per?: "day" | "week"; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo": number; + "since-repo"?: number; /** @description The unique identifier of the SCIM user. */ "scim-user-id": string; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order: "desc" | "asc"; + order?: "desc" | "asc"; /** @description The unique identifier of the team. */ "team-id": number; /** @description ID of the Repository to filter on */ - "repository-id-in-query": number; + "repository-id-in-query"?: number; /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ "export-id": string; /** @description The unique identifier of the GPG key. */ "gpg-key-id": number; /** @description Only show repositories 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-repo-date": string; + "since-repo-date"?: string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "before-repo-date": string; + "before-repo-date"?: string; /** @description The unique identifier of the SSH signing key. */ "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - "sort-starred": "created" | "updated"; + "sort-starred"?: "created" | "updated"; }; requestBodies: never; headers: { @@ -85158,7 +85158,7 @@ export interface operations { client_secret: string; webhook_secret: string | null; pem: string; - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -87253,44 +87253,40 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The description of the gist. - * @example Example Ruby script - */ - description?: string; - /** - * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - * (including extension) of the targeted gist file. For example: `hello.py`. - * - * To delete a file, set the whole file to null. For example: `hello.py : null`. - * @example { - * "hello.rb": { - * "content": "blah", - * "filename": "goodbye.rb" - * } - * } - */ - files?: { - [key: string]: - | ( - | ({ - /** @description The new content of the file. */ - content?: string; - /** @description The new filename for the file. */ - filename?: string | null; - } & ( - | Record - | Record - | Record - )) - | null - ) - | undefined; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The description of the gist. + * @example Example Ruby script + */ + description?: string; + /** + * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename + * (including extension) of the targeted gist file. For example: `hello.py`. + * + * To delete a file, set the whole file to null. For example: `hello.py : null`. + * @example { + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } + */ + files?: { + [key: string]: + | OneOf< + [ + { + /** @description The new content of the file. */ + content?: string; + /** @description The new filename for the file. */ + filename?: string | null; + }, + Record + ] + > + | undefined; + }; + } | null; }; }; responses: { @@ -98132,7 +98128,7 @@ export interface operations { ref: string; /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ inputs?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -99543,12 +99539,12 @@ export interface operations { { /** @enum {unknown} */ status: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; }, { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ] >; @@ -99693,12 +99689,12 @@ export interface operations { | { /** @enum {unknown} */ status?: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; } | { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ); }; @@ -100157,7 +100153,7 @@ export interface operations { content: { "application/json": components["schemas"]["code-scanning-analysis"]; "application/json+sarif": { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -102553,7 +102549,7 @@ export interface operations { payload?: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -102795,7 +102791,7 @@ export interface operations { event_type: string; /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ client_payload?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -106377,13 +106373,7 @@ export interface operations { }; /** @description Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. */ public?: boolean; - } & ( - | Record - | Record - | Record - | Record - | Record - ); + }; }; }; responses: { @@ -106409,26 +106399,24 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path?: "/" | "/docs"; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path?: "/" | "/docs"; + }; + } | null; }; }; responses: { @@ -107444,7 +107432,7 @@ export interface operations { }; /** * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ "pulls/request-reviewers": { parameters: { @@ -107461,7 +107449,7 @@ export interface operations { reviewers?: string[]; /** @description An array of team `slug`s that will be requested. */ team_reviewers?: string[]; - } & (Record | Record); + }; }; }; responses: { diff --git a/packages/openapi-types-ghes-3.5/package.json b/packages/openapi-types-ghes-3.5/package.json index dee587700..5a15dc19e 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": "11.1.0" + "openapi-version": "11.1.1" } } diff --git a/packages/openapi-types-ghes-3.5/types.d.ts b/packages/openapi-types-ghes-3.5/types.d.ts index 1114d65e1..227b09c8e 100644 --- a/packages/openapi-types-ghes-3.5/types.d.ts +++ b/packages/openapi-types-ghes-3.5/types.d.ts @@ -5146,7 +5146,7 @@ export interface paths { get: operations["pulls/list-requested-reviewers"]; /** * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.5/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ post: operations["pulls/request-reviewers"]; /** Remove requested reviewers from a pull request */ @@ -7898,17 +7898,17 @@ export interface components { request: { /** @description The request headers sent with the webhook delivery. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The webhook payload. */ payload: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; }; response: { /** @description The response headers received when the delivery was made. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The response payload received. */ payload: string | null; @@ -8894,7 +8894,7 @@ export interface components { country_name?: string; }; data?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; org_id?: number; user_id?: number; @@ -9746,8 +9746,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; }; /** * Public User @@ -9895,8 +9895,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["nullable-simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; } | null; url?: string; forks_url?: string; @@ -13177,7 +13177,7 @@ export interface components { payload: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -18232,13 +18232,13 @@ export interface components { ldap?: { host?: string | null; port?: number; - base?: Record[]; + base?: unknown[]; uid?: string | null; bind_dn?: string | null; password?: string | null; method?: string; search_strategy?: string; - user_groups?: Record[]; + user_groups?: unknown[]; admin_group?: string | null; virtual_attribute_enabled?: boolean; recursive_group_search?: boolean; @@ -18522,7 +18522,7 @@ export interface components { email?: string; verified?: boolean; }[]; - subkeys?: Record[]; + subkeys?: unknown[]; can_sign?: boolean; can_encrypt_comms?: boolean; can_encrypt_storage?: boolean; @@ -18725,13 +18725,13 @@ export interface components { }; parameters: { /** @description The number of results per page (max 100). */ - "per-page": number; + "per-page"?: number; /** @description Page number of the results to fetch. */ - page: number; + page?: number; /** @description The unique identifier of the hook. */ "hook-id": number; /** @description The direction to sort the results by. */ - direction: "asc" | "desc"; + direction?: "asc" | "desc"; /** @description The unique identifier of the key. */ "key-ids": string; /** @description The unique identifier of the team. */ @@ -18747,10 +18747,10 @@ export interface components { /** @description The unique identifier of the token. */ "token-id": number; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor: string; + cursor?: string; "delivery-id": number; /** @description 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: string; + since?: string; /** @description The unique identifier of the installation. */ "installation-id": number; /** @description The unique identifier of the grant. */ @@ -18773,7 +18773,7 @@ export interface components { /** @description The name of a self-hosted runner's custom label. */ "runner-label-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.5/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ - "audit-log-enterprise-phrase": string; + "audit-log-enterprise-phrase"?: string; /** * @description The event types to include: * @@ -18783,61 +18783,61 @@ export interface components { * * The default is `web`. */ - "audit-log-include": "web" | "git" | "all"; + "audit-log-include"?: "web" | "git" | "all"; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.5/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ - "audit-log-after": string; + "audit-log-after"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.5/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ - "audit-log-before": string; + "audit-log-before"?: string; /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - "audit-log-order": "desc" | "asc"; + "audit-log-order"?: "desc" | "asc"; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; + "secret-scanning-alert-state"?: "open" | "resolved"; /** * @description A comma-separated list of secret types to return. By default all secret types are returned. * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.5/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" * for a complete list of secret types. */ - "secret-scanning-alert-secret-type": string; + "secret-scanning-alert-secret-type"?: string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; + "secret-scanning-alert-resolution"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.5/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */ - "pagination-before": string; + "pagination-before"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.5/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */ - "pagination-after": string; + "pagination-after"?: string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels: string; + labels?: string; /** @description The account owner of the repository. The name is not case sensitive. */ owner: string; /** @description The name of the repository. The name is not case sensitive. */ repo: string; /** @description If `true`, show notifications marked as read. */ - all: boolean; + all?: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating: boolean; + participating?: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before: string; + before?: string; /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org": number; + "since-org"?: number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description The name of the secret. */ "secret-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.5/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase": string; + "audit-log-phrase"?: string; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + "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"]; + "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"]; /** @description The unique identifier of the migration. */ "migration-id": number; /** @description repo_name parameter */ @@ -18861,13 +18861,13 @@ export interface components { /** @description The unique identifier of the job. */ "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor: string; + actor?: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch": string; + "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.5/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event: string; + event?: string; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ - "workflow-run-status": + "workflow-run-status"?: | "completed" | "action_required" | "cancelled" @@ -18883,11 +18883,11 @@ export interface components { | "waiting" | "pending"; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.5/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created: string; + created?: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests": boolean; + "exclude-pull-requests"?: boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id": number; + "workflow-run-check-suite-id"?: number; /** @description The unique identifier of the workflow run. */ "run-id": number; /** @description The attempt number of the workflow run. */ @@ -18903,11 +18903,11 @@ export interface components { /** @description The unique identifier of the check suite. */ "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - "check-name": string; + "check-name"?: string; /** @description Returns check runs with the specified `status`. */ - status: "queued" | "in_progress" | "completed"; + status?: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - "git-ref": components["schemas"]["code-scanning-ref"]; + "git-ref"?: components["schemas"]["code-scanning-ref"]; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -18921,7 +18921,7 @@ export interface components { /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ - sort: "created" | "updated"; + sort?: "created" | "updated"; /** @description The number that identifies the issue. */ "issue-number": number; /** @description The unique identifier of the key. */ @@ -18939,19 +18939,19 @@ export interface components { /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo": number; + "since-repo"?: number; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order: "desc" | "asc"; + order?: "desc" | "asc"; /** @description The unique identifier of the GPG key. */ "gpg-key-id": number; /** @description Only show repositories 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-repo-date": string; + "since-repo-date"?: string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "before-repo-date": string; + "before-repo-date"?: string; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - "sort-starred": "created" | "updated"; + "sort-starred"?: "created" | "updated"; /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user": number; + "since-user"?: number; }; requestBodies: never; headers: { @@ -19533,11 +19533,11 @@ export interface operations { script: string; /** @description The GitHub repository where the script is kept. */ script_repository: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The pre-receive environment where the script is executed. */ environment: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The state of enforcement for this hook. default: `disabled` */ enforcement?: string; @@ -19599,11 +19599,11 @@ export interface operations { script?: string; /** @description The GitHub repository where the script is kept. */ script_repository?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The pre-receive environment where the script is executed. */ environment?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The state of enforcement for this hook. */ enforcement?: string; @@ -19812,7 +19812,7 @@ export interface operations { client_secret: string; webhook_secret: string | null; pem: string; - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -22082,44 +22082,40 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The description of the gist. - * @example Example Ruby script - */ - description?: string; - /** - * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - * (including extension) of the targeted gist file. For example: `hello.py`. - * - * To delete a file, set the whole file to null. For example: `hello.py : null`. - * @example { - * "hello.rb": { - * "content": "blah", - * "filename": "goodbye.rb" - * } - * } - */ - files?: { - [key: string]: - | ( - | ({ - /** @description The new content of the file. */ - content?: string; - /** @description The new filename for the file. */ - filename?: string | null; - } & ( - | Record - | Record - | Record - )) - | null - ) - | undefined; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The description of the gist. + * @example Example Ruby script + */ + description?: string; + /** + * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename + * (including extension) of the targeted gist file. For example: `hello.py`. + * + * To delete a file, set the whole file to null. For example: `hello.py : null`. + * @example { + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } + */ + files?: { + [key: string]: + | OneOf< + [ + { + /** @description The new content of the file. */ + content?: string; + /** @description The new filename for the file. */ + filename?: string | null; + }, + Record + ] + > + | undefined; + }; + } | null; }; }; responses: { @@ -29287,7 +29283,7 @@ export interface operations { ref: string; /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ inputs?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -30622,12 +30618,12 @@ export interface operations { { /** @enum {unknown} */ status: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; }, { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ] >; @@ -30772,12 +30768,12 @@ export interface operations { | { /** @enum {unknown} */ status?: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; } | { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ); }; @@ -31233,7 +31229,7 @@ export interface operations { content: { "application/json": components["schemas"]["code-scanning-analysis"]; "application/json+sarif": { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -32828,7 +32824,7 @@ export interface operations { payload?: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -33070,7 +33066,7 @@ export interface operations { event_type: string; /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ client_payload?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -36122,13 +36118,7 @@ export interface operations { */ path: "/" | "/docs"; }; - } & ( - | Record - | Record - | Record - | Record - | Record - ); + }; }; }; responses: { @@ -36154,26 +36144,24 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path?: "/" | "/docs"; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path?: "/" | "/docs"; + }; + } | null; }; }; responses: { @@ -37138,7 +37126,7 @@ export interface operations { }; /** * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.5/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ "pulls/request-reviewers": { parameters: { @@ -37155,7 +37143,7 @@ export interface operations { reviewers?: string[]; /** @description An array of team `slug`s that will be requested. */ team_reviewers?: string[]; - } & (Record | Record); + }; }; }; responses: { diff --git a/packages/openapi-types-ghes-3.6/package.json b/packages/openapi-types-ghes-3.6/package.json index aa5bf9373..ab424e2aa 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": "11.1.0" + "openapi-version": "11.1.1" } } diff --git a/packages/openapi-types-ghes-3.6/types.d.ts b/packages/openapi-types-ghes-3.6/types.d.ts index 5ef16cf3f..5f73c4dee 100644 --- a/packages/openapi-types-ghes-3.6/types.d.ts +++ b/packages/openapi-types-ghes-3.6/types.d.ts @@ -5241,7 +5241,7 @@ export interface paths { get: operations["pulls/list-requested-reviewers"]; /** * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.6/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ post: operations["pulls/request-reviewers"]; /** Remove requested reviewers from a pull request */ @@ -8114,17 +8114,17 @@ export interface components { request: { /** @description The request headers sent with the webhook delivery. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The webhook payload. */ payload: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; }; response: { /** @description The response headers received when the delivery was made. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The response payload received. */ payload: string | null; @@ -9205,7 +9205,7 @@ export interface components { country_name?: string; }; data?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; org_id?: number; user_id?: number; @@ -10065,8 +10065,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; }; /** * Public User @@ -10214,8 +10214,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["nullable-simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; } | null; url?: string; forks_url?: string; @@ -13758,7 +13758,7 @@ export interface components { payload: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -19227,13 +19227,13 @@ export interface components { ldap?: { host?: string | null; port?: number; - base?: Record[]; + base?: unknown[]; uid?: string | null; bind_dn?: string | null; password?: string | null; method?: string; search_strategy?: string; - user_groups?: Record[]; + user_groups?: unknown[]; admin_group?: string | null; virtual_attribute_enabled?: boolean; recursive_group_search?: boolean; @@ -19520,7 +19520,7 @@ export interface components { email?: string; verified?: boolean; }[]; - subkeys?: Record[]; + subkeys?: unknown[]; can_sign?: boolean; can_encrypt_comms?: boolean; can_encrypt_storage?: boolean; @@ -19753,13 +19753,13 @@ export interface components { }; parameters: { /** @description The number of results per page (max 100). */ - "per-page": number; + "per-page"?: number; /** @description Page number of the results to fetch. */ - page: number; + page?: number; /** @description The unique identifier of the hook. */ "hook-id": number; /** @description The direction to sort the results by. */ - direction: "asc" | "desc"; + direction?: "asc" | "desc"; /** @description The unique identifier of the key. */ "key-ids": string; /** @description The unique identifier of the team. */ @@ -19775,10 +19775,10 @@ export interface components { /** @description The unique identifier of the token. */ "token-id": number; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor: string; + cursor?: string; "delivery-id": number; /** @description 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: string; + since?: string; /** @description The unique identifier of the installation. */ "installation-id": number; /** @description The unique identifier of the grant. */ @@ -19795,7 +19795,7 @@ export interface components { /** @description The unique identifier of the organization. */ "org-id": number; /** @description Only return runner groups that are allowed to be used by this organization. */ - "visible-to-organization": string; + "visible-to-organization"?: string; /** @description Unique identifier of the self-hosted runner group. */ "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ @@ -19803,7 +19803,7 @@ export interface components { /** @description The name of a self-hosted runner's custom label. */ "runner-label-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.6/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ - "audit-log-enterprise-phrase": string; + "audit-log-enterprise-phrase"?: string; /** * @description The event types to include: * @@ -19813,65 +19813,65 @@ export interface components { * * The default is `web`. */ - "audit-log-include": "web" | "git" | "all"; + "audit-log-include"?: "web" | "git" | "all"; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.6/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ - "audit-log-after": string; + "audit-log-after"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.6/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ - "audit-log-before": string; + "audit-log-before"?: string; /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - "audit-log-order": "desc" | "asc"; + "audit-log-order"?: "desc" | "asc"; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; + "secret-scanning-alert-state"?: "open" | "resolved"; /** * @description A comma-separated list of secret types to return. By default all secret types are returned. * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.6/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" * for a complete list of secret types. */ - "secret-scanning-alert-secret-type": string; + "secret-scanning-alert-secret-type"?: string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; + "secret-scanning-alert-resolution"?: string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "secret-scanning-alert-sort": "created" | "updated"; + "secret-scanning-alert-sort"?: "created" | "updated"; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.6/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */ - "pagination-before": string; + "pagination-before"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.6/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */ - "pagination-after": string; + "pagination-after"?: string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels: string; + labels?: string; /** @description The account owner of the repository. The name is not case sensitive. */ owner: string; /** @description The name of the repository. The name is not case sensitive. */ repo: string; /** @description If `true`, show notifications marked as read. */ - all: boolean; + all?: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating: boolean; + participating?: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before: string; + before?: string; /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org": number; + "since-org"?: number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ - "visible-to-repository": string; + "visible-to-repository"?: string; /** @description The name of the secret. */ "secret-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.6/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase": string; + "audit-log-phrase"?: string; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + "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"]; + "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. */ @@ -19897,13 +19897,13 @@ export interface components { /** @description The unique identifier of the job. */ "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor: string; + actor?: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch": string; + "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.6/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event: string; + event?: string; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ - "workflow-run-status": + "workflow-run-status"?: | "completed" | "action_required" | "cancelled" @@ -19919,11 +19919,11 @@ export interface components { | "waiting" | "pending"; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.6/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created: string; + created?: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests": boolean; + "exclude-pull-requests"?: boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id": number; + "workflow-run-check-suite-id"?: number; /** @description The unique identifier of the workflow run. */ "run-id": number; /** @description The attempt number of the workflow run. */ @@ -19939,17 +19939,17 @@ export interface components { /** @description The unique identifier of the check suite. */ "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - "check-name": string; + "check-name"?: string; /** @description Returns check runs with the specified `status`. */ - status: "queued" | "in_progress" | "completed"; + status?: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - "git-ref": components["schemas"]["code-scanning-ref"]; + "git-ref"?: components["schemas"]["code-scanning-ref"]; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ "commit-sha": string; /** @description The full path, relative to the repository root, of the dependency manifest file. */ - "manifest-path": string; + "manifest-path"?: string; /** @description deployment_id parameter */ "deployment-id": number; /** @description The name of the environment. */ @@ -19959,7 +19959,7 @@ export interface components { /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ - sort: "created" | "updated"; + sort?: "created" | "updated"; /** @description The number that identifies the issue. */ "issue-number": number; /** @description The unique identifier of the key. */ @@ -19977,29 +19977,29 @@ export interface components { /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo": number; + "since-repo"?: number; /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ - "excluded-attributes": string; + "excluded-attributes"?: string; /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ - "start-index": number; + "start-index"?: number; /** @description Used for pagination: the number of results to return per page. */ - count: number; + count?: number; /** @description A unique identifier of the SCIM group. */ "scim-group-id": string; /** @description The unique identifier of the SCIM user. */ "scim-user-id": string; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order: "desc" | "asc"; + order?: "desc" | "asc"; /** @description The unique identifier of the GPG key. */ "gpg-key-id": number; /** @description Only show repositories 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-repo-date": string; + "since-repo-date"?: string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "before-repo-date": string; + "before-repo-date"?: string; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - "sort-starred": "created" | "updated"; + "sort-starred"?: "created" | "updated"; /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user": number; + "since-user"?: number; }; requestBodies: never; headers: { @@ -20581,11 +20581,11 @@ export interface operations { script: string; /** @description The GitHub repository where the script is kept. */ script_repository: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The pre-receive environment where the script is executed. */ environment: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The state of enforcement for this hook. default: `disabled` */ enforcement?: string; @@ -20647,11 +20647,11 @@ export interface operations { script?: string; /** @description The GitHub repository where the script is kept. */ script_repository?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The pre-receive environment where the script is executed. */ environment?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The state of enforcement for this hook. */ enforcement?: string; @@ -20860,7 +20860,7 @@ export interface operations { client_secret: string; webhook_secret: string | null; pem: string; - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -23180,44 +23180,40 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The description of the gist. - * @example Example Ruby script - */ - description?: string; - /** - * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - * (including extension) of the targeted gist file. For example: `hello.py`. - * - * To delete a file, set the whole file to null. For example: `hello.py : null`. - * @example { - * "hello.rb": { - * "content": "blah", - * "filename": "goodbye.rb" - * } - * } - */ - files?: { - [key: string]: - | ( - | ({ - /** @description The new content of the file. */ - content?: string; - /** @description The new filename for the file. */ - filename?: string | null; - } & ( - | Record - | Record - | Record - )) - | null - ) - | undefined; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The description of the gist. + * @example Example Ruby script + */ + description?: string; + /** + * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename + * (including extension) of the targeted gist file. For example: `hello.py`. + * + * To delete a file, set the whole file to null. For example: `hello.py : null`. + * @example { + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } + */ + files?: { + [key: string]: + | OneOf< + [ + { + /** @description The new content of the file. */ + content?: string; + /** @description The new filename for the file. */ + filename?: string | null; + }, + Record + ] + > + | undefined; + }; + } | null; }; }; responses: { @@ -30595,7 +30591,7 @@ export interface operations { ref: string; /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ inputs?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -31930,12 +31926,12 @@ export interface operations { { /** @enum {unknown} */ status: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; }, { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ] >; @@ -32080,12 +32076,12 @@ export interface operations { | { /** @enum {unknown} */ status?: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; } | { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ); }; @@ -32542,7 +32538,7 @@ export interface operations { content: { "application/json": components["schemas"]["code-scanning-analysis"]; "application/json+sarif": { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -34173,7 +34169,7 @@ export interface operations { payload?: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -34415,7 +34411,7 @@ export interface operations { event_type: string; /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ client_payload?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -37467,13 +37463,7 @@ export interface operations { */ path: "/" | "/docs"; }; - } & ( - | Record - | Record - | Record - | Record - | Record - ); + }; }; }; responses: { @@ -37499,26 +37489,24 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path?: "/" | "/docs"; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path?: "/" | "/docs"; + }; + } | null; }; }; responses: { @@ -38483,7 +38471,7 @@ export interface operations { }; /** * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.6/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ "pulls/request-reviewers": { parameters: { @@ -38500,7 +38488,7 @@ export interface operations { reviewers?: string[]; /** @description An array of team `slug`s that will be requested. */ team_reviewers?: string[]; - } & (Record | Record); + }; }; }; responses: { diff --git a/packages/openapi-types-ghes-3.7/package.json b/packages/openapi-types-ghes-3.7/package.json index 35b0fb9e9..1865c8963 100644 --- a/packages/openapi-types-ghes-3.7/package.json +++ b/packages/openapi-types-ghes-3.7/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "11.1.0" + "openapi-version": "11.1.1" } } diff --git a/packages/openapi-types-ghes-3.7/types.d.ts b/packages/openapi-types-ghes-3.7/types.d.ts index 661c91164..d18aacc56 100644 --- a/packages/openapi-types-ghes-3.7/types.d.ts +++ b/packages/openapi-types-ghes-3.7/types.d.ts @@ -5375,7 +5375,7 @@ export interface paths { get: operations["pulls/list-requested-reviewers"]; /** * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.7/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.7/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ post: operations["pulls/request-reviewers"]; /** Remove requested reviewers from a pull request */ @@ -8415,17 +8415,17 @@ export interface components { request: { /** @description The request headers sent with the webhook delivery. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The webhook payload. */ payload: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; }; response: { /** @description The response headers received when the delivery was made. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The response payload received. */ payload: string | null; @@ -9512,7 +9512,7 @@ export interface components { country_name?: string; }; data?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; org_id?: number; user_id?: number; @@ -10509,8 +10509,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; }; /** * Public User @@ -10658,8 +10658,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["nullable-simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; } | null; url?: string; forks_url?: string; @@ -14229,7 +14229,7 @@ export interface components { payload: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -19787,13 +19787,13 @@ export interface components { ldap?: { host?: string | null; port?: number; - base?: Record[]; + base?: unknown[]; uid?: string | null; bind_dn?: string | null; password?: string | null; method?: string; search_strategy?: string; - user_groups?: Record[]; + user_groups?: unknown[]; admin_group?: string | null; virtual_attribute_enabled?: boolean; recursive_group_search?: boolean; @@ -20080,7 +20080,7 @@ export interface components { email?: string; verified?: boolean; }[]; - subkeys?: Record[]; + subkeys?: unknown[]; can_sign?: boolean; can_encrypt_comms?: boolean; can_encrypt_storage?: boolean; @@ -39266,7 +39266,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; npm_metadata?: { @@ -39524,7 +39524,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; package_files: { @@ -70043,7 +70043,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; npm_metadata?: { @@ -70239,7 +70239,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; package_files: { @@ -71572,7 +71572,7 @@ export interface components { action: string; branch: string; client_payload: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; enterprise?: components["schemas"]["enterprise"]; installation: components["schemas"]["simple-installation"]; @@ -75059,7 +75059,7 @@ export interface components { "webhook-workflow-dispatch": { enterprise?: components["schemas"]["enterprise"]; inputs: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple"]; @@ -77421,13 +77421,13 @@ export interface components { }; parameters: { /** @description The number of results per page (max 100). */ - "per-page": number; + "per-page"?: number; /** @description Page number of the results to fetch. */ - page: number; + page?: number; /** @description The unique identifier of the hook. */ "hook-id": number; /** @description The direction to sort the results by. */ - direction: "asc" | "desc"; + direction?: "asc" | "desc"; /** @description The unique identifier of the key. */ "key-ids": string; /** @description The unique identifier of the team. */ @@ -77443,10 +77443,10 @@ export interface components { /** @description The unique identifier of the token. */ "token-id": number; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor: string; + cursor?: string; "delivery-id": number; /** @description 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: string; + since?: string; /** @description The unique identifier of the installation. */ "installation-id": number; /** @description The unique identifier of the grant. */ @@ -77463,7 +77463,7 @@ export interface components { /** @description The unique identifier of the organization. */ "org-id": number; /** @description Only return runner groups that are allowed to be used by this organization. */ - "visible-to-organization": string; + "visible-to-organization"?: string; /** @description Unique identifier of the self-hosted runner group. */ "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ @@ -77471,7 +77471,7 @@ export interface components { /** @description The name of a self-hosted runner's custom label. */ "runner-label-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.7/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ - "audit-log-enterprise-phrase": string; + "audit-log-enterprise-phrase"?: string; /** * @description The event types to include: * @@ -77481,65 +77481,65 @@ export interface components { * * The default is `web`. */ - "audit-log-include": "web" | "git" | "all"; + "audit-log-include"?: "web" | "git" | "all"; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.7/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ - "audit-log-after": string; + "audit-log-after"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.7/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ - "audit-log-before": string; + "audit-log-before"?: string; /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - "audit-log-order": "desc" | "asc"; + "audit-log-order"?: "desc" | "asc"; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + "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"]; + "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"]; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.7/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */ - "pagination-before": string; + "pagination-before"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.7/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */ - "pagination-after": string; + "pagination-after"?: string; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; + "secret-scanning-alert-state"?: "open" | "resolved"; /** * @description A comma-separated list of secret types to return. By default all secret types are returned. * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.7/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" * for a complete list of secret types. */ - "secret-scanning-alert-secret-type": string; + "secret-scanning-alert-secret-type"?: string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; + "secret-scanning-alert-resolution"?: string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "secret-scanning-alert-sort": "created" | "updated"; + "secret-scanning-alert-sort"?: "created" | "updated"; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels: string; + labels?: string; /** @description The account owner of the repository. The name is not case sensitive. */ owner: string; /** @description The name of the repository. The name is not case sensitive. */ repo: string; /** @description If `true`, show notifications marked as read. */ - all: boolean; + all?: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating: boolean; + participating?: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before: string; + before?: string; /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.7/rest/reference/activity#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org": number; + "since-org"?: number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ - "visible-to-repository": string; + "visible-to-repository"?: string; /** @description The name of the secret. */ "secret-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.7/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase": string; + "audit-log-phrase"?: string; /** @description The unique identifier of the group. */ "group-id": number; /** @description The unique identifier of the migration. */ @@ -77547,9 +77547,9 @@ export interface components { /** @description repo_name parameter */ "repo-name": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.7/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - "secret-scanning-pagination-before-org-repo": string; + "secret-scanning-pagination-before-org-repo"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.7/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - "secret-scanning-pagination-after-org-repo": string; + "secret-scanning-pagination-after-org-repo"?: string; /** @description The slug of the team name. */ "team-slug": string; /** @description The number that identifies the discussion. */ @@ -77582,11 +77582,11 @@ export interface components { /** @description The unique identifier of the artifact. */ "artifact-id": number; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - "actions-cache-git-ref-full": string; + "actions-cache-git-ref-full"?: string; /** @description An explicit key or prefix for identifying the cache */ - "actions-cache-key": string; + "actions-cache-key"?: string; /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ - "actions-cache-list-sort": + "actions-cache-list-sort"?: | "created_at" | "last_accessed_at" | "size_in_bytes"; @@ -77597,13 +77597,13 @@ export interface components { /** @description The unique identifier of the job. */ "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor: string; + actor?: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch": string; + "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.7/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event: string; + event?: string; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ - "workflow-run-status": + "workflow-run-status"?: | "completed" | "action_required" | "cancelled" @@ -77619,13 +77619,13 @@ export interface components { | "waiting" | "pending"; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.7/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created: string; + created?: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests": boolean; + "exclude-pull-requests"?: boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id": number; + "workflow-run-check-suite-id"?: number; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - "workflow-run-head-sha": string; + "workflow-run-head-sha"?: string; /** @description The unique identifier of the workflow run. */ "run-id": number; /** @description The attempt number of the workflow run. */ @@ -77641,17 +77641,17 @@ export interface components { /** @description The unique identifier of the check suite. */ "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - "check-name": string; + "check-name"?: string; /** @description Returns check runs with the specified `status`. */ - status: "queued" | "in_progress" | "completed"; + status?: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - "git-ref": components["schemas"]["code-scanning-ref"]; + "git-ref"?: components["schemas"]["code-scanning-ref"]; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ "commit-sha": string; /** @description The full path, relative to the repository root, of the dependency manifest file. */ - "manifest-path": string; + "manifest-path"?: string; /** @description deployment_id parameter */ "deployment-id": number; /** @description The name of the environment. */ @@ -77661,7 +77661,7 @@ export interface components { /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ - sort: "created" | "updated"; + sort?: "created" | "updated"; /** @description The number that identifies the issue. */ "issue-number": number; /** @description The unique identifier of the key. */ @@ -77679,31 +77679,31 @@ export interface components { /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo": number; + "since-repo"?: number; /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ - "excluded-attributes": string; + "excluded-attributes"?: string; /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ - "start-index": number; + "start-index"?: number; /** @description Used for pagination: the number of results to return per page. */ - count: number; + count?: number; /** @description A unique identifier of the SCIM group. */ "scim-group-id": string; /** @description The unique identifier of the SCIM user. */ "scim-user-id": string; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order: "desc" | "asc"; + order?: "desc" | "asc"; /** @description The unique identifier of the GPG key. */ "gpg-key-id": number; /** @description Only show repositories 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-repo-date": string; + "since-repo-date"?: string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "before-repo-date": string; + "before-repo-date"?: string; /** @description The unique identifier of the SSH signing key. */ "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - "sort-starred": "created" | "updated"; + "sort-starred"?: "created" | "updated"; /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user": number; + "since-user"?: number; }; requestBodies: never; headers: { @@ -78285,11 +78285,11 @@ export interface operations { script: string; /** @description The GitHub repository where the script is kept. */ script_repository: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The pre-receive environment where the script is executed. */ environment: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The state of enforcement for this hook. default: `disabled` */ enforcement?: string; @@ -78351,11 +78351,11 @@ export interface operations { script?: string; /** @description The GitHub repository where the script is kept. */ script_repository?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The pre-receive environment where the script is executed. */ environment?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The state of enforcement for this hook. */ enforcement?: string; @@ -78569,7 +78569,7 @@ export interface operations { client_secret: string; webhook_secret: string | null; pem: string; - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -80929,44 +80929,40 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The description of the gist. - * @example Example Ruby script - */ - description?: string; - /** - * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - * (including extension) of the targeted gist file. For example: `hello.py`. - * - * To delete a file, set the whole file to null. For example: `hello.py : null`. - * @example { - * "hello.rb": { - * "content": "blah", - * "filename": "goodbye.rb" - * } - * } - */ - files?: { - [key: string]: - | ( - | ({ - /** @description The new content of the file. */ - content?: string; - /** @description The new filename for the file. */ - filename?: string | null; - } & ( - | Record - | Record - | Record - )) - | null - ) - | undefined; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The description of the gist. + * @example Example Ruby script + */ + description?: string; + /** + * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename + * (including extension) of the targeted gist file. For example: `hello.py`. + * + * To delete a file, set the whole file to null. For example: `hello.py : null`. + * @example { + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } + */ + files?: { + [key: string]: + | OneOf< + [ + { + /** @description The new content of the file. */ + content?: string; + /** @description The new filename for the file. */ + filename?: string | null; + }, + Record + ] + > + | undefined; + }; + } | null; }; }; responses: { @@ -88676,7 +88672,7 @@ export interface operations { ref: string; /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ inputs?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -90012,12 +90008,12 @@ export interface operations { { /** @enum {unknown} */ status: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; }, { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ] >; @@ -90162,12 +90158,12 @@ export interface operations { | { /** @enum {unknown} */ status?: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; } | { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ); }; @@ -90627,7 +90623,7 @@ export interface operations { content: { "application/json": components["schemas"]["code-scanning-analysis"]; "application/json+sarif": { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -92292,7 +92288,7 @@ export interface operations { payload?: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -92534,7 +92530,7 @@ export interface operations { event_type: string; /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ client_payload?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -95590,13 +95586,7 @@ export interface operations { */ path: "/" | "/docs"; }; - } & ( - | Record - | Record - | Record - | Record - | Record - ); + }; }; }; responses: { @@ -95622,26 +95612,24 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path?: "/" | "/docs"; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path?: "/" | "/docs"; + }; + } | null; }; }; responses: { @@ -96651,7 +96639,7 @@ export interface operations { }; /** * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.7/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.7/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ "pulls/request-reviewers": { parameters: { @@ -96668,7 +96656,7 @@ export interface operations { reviewers?: string[]; /** @description An array of team `slug`s that will be requested. */ team_reviewers?: string[]; - } & (Record | Record); + }; }; }; responses: { diff --git a/packages/openapi-types-ghes-3.8/package.json b/packages/openapi-types-ghes-3.8/package.json index 394095294..bc6a909cc 100644 --- a/packages/openapi-types-ghes-3.8/package.json +++ b/packages/openapi-types-ghes-3.8/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "11.1.0" + "openapi-version": "11.1.1" } } diff --git a/packages/openapi-types-ghes-3.8/types.d.ts b/packages/openapi-types-ghes-3.8/types.d.ts index c2aac3221..0e90e4c31 100644 --- a/packages/openapi-types-ghes-3.8/types.d.ts +++ b/packages/openapi-types-ghes-3.8/types.d.ts @@ -5674,7 +5674,7 @@ export interface paths { get: operations["pulls/list-requested-reviewers"]; /** * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.8/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.8/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ post: operations["pulls/request-reviewers"]; /** Remove requested reviewers from a pull request */ @@ -9655,17 +9655,17 @@ export interface components { request: { /** @description The request headers sent with the webhook delivery. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The webhook payload. */ payload: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; }; response: { /** @description The response headers received when the delivery was made. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The response payload received. */ payload: string | null; @@ -10752,7 +10752,7 @@ export interface components { country_name?: string; }; data?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; org_id?: number; user_id?: number; @@ -11897,8 +11897,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; }; /** * Public User @@ -12046,8 +12046,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["nullable-simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; } | null; url?: string; forks_url?: string; @@ -15774,7 +15774,7 @@ export interface components { payload: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -21471,13 +21471,13 @@ export interface components { ldap?: { host?: string | null; port?: number; - base?: Record[]; + base?: unknown[]; uid?: string | null; bind_dn?: string | null; password?: string | null; method?: string; search_strategy?: string; - user_groups?: Record[]; + user_groups?: unknown[]; admin_group?: string | null; virtual_attribute_enabled?: boolean; recursive_group_search?: boolean; @@ -21764,7 +21764,7 @@ export interface components { email?: string; verified?: boolean; }[]; - subkeys?: Record[]; + subkeys?: unknown[]; can_sign?: boolean; can_encrypt_comms?: boolean; can_encrypt_storage?: boolean; @@ -40814,7 +40814,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; npm_metadata?: { @@ -41072,7 +41072,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; package_files: { @@ -71591,7 +71591,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; npm_metadata?: { @@ -71787,7 +71787,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; package_files: { @@ -73120,7 +73120,7 @@ export interface components { action: string; branch: string; client_payload: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; enterprise?: components["schemas"]["enterprise"]; installation: components["schemas"]["simple-installation"]; @@ -76607,7 +76607,7 @@ export interface components { "webhook-workflow-dispatch": { enterprise?: components["schemas"]["enterprise"]; inputs: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple"]; @@ -79037,13 +79037,13 @@ export interface components { }; parameters: { /** @description The number of results per page (max 100). */ - "per-page": number; + "per-page"?: number; /** @description Page number of the results to fetch. */ - page: number; + page?: number; /** @description The unique identifier of the hook. */ "hook-id": number; /** @description The direction to sort the results by. */ - direction: "asc" | "desc"; + direction?: "asc" | "desc"; /** @description The unique identifier of the key. */ "key-ids": string; /** @description The unique identifier of the team. */ @@ -79059,10 +79059,10 @@ export interface components { /** @description The unique identifier of the token. */ "token-id": number; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor: string; + cursor?: string; "delivery-id": number; /** @description 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: string; + since?: string; /** @description The unique identifier of the installation. */ "installation-id": number; /** @description The unique identifier of the grant. */ @@ -79079,7 +79079,7 @@ export interface components { /** @description The unique identifier of the organization. */ "org-id": number; /** @description Only return runner groups that are allowed to be used by this organization. */ - "visible-to-organization": string; + "visible-to-organization"?: string; /** @description Unique identifier of the self-hosted runner group. */ "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ @@ -79087,7 +79087,7 @@ export interface components { /** @description The name of a self-hosted runner's custom label. */ "runner-label-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.8/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ - "audit-log-enterprise-phrase": string; + "audit-log-enterprise-phrase"?: string; /** * @description The event types to include: * @@ -79097,77 +79097,77 @@ export interface components { * * The default is `web`. */ - "audit-log-include": "web" | "git" | "all"; + "audit-log-include"?: "web" | "git" | "all"; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.8/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ - "audit-log-after": string; + "audit-log-after"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.8/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ - "audit-log-before": string; + "audit-log-before"?: string; /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - "audit-log-order": "desc" | "asc"; + "audit-log-order"?: "desc" | "asc"; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + "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"]; + "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"]; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.8/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */ - "pagination-before": string; + "pagination-before"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.8/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */ - "pagination-after": string; + "pagination-after"?: string; /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ - "dependabot-alert-comma-separated-states": string; + "dependabot-alert-comma-separated-states"?: string; /** * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * * Can be: `low`, `medium`, `high`, `critical` */ - "dependabot-alert-comma-separated-severities": string; + "dependabot-alert-comma-separated-severities"?: string; /** * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ - "dependabot-alert-comma-separated-ecosystems": string; + "dependabot-alert-comma-separated-ecosystems"?: string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - "dependabot-alert-comma-separated-packages": string; + "dependabot-alert-comma-separated-packages"?: string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - "dependabot-alert-scope": "development" | "runtime"; + "dependabot-alert-scope"?: "development" | "runtime"; /** * @description The property by which to sort the results. * `created` means when the alert was created. * `updated` means when the alert's state last changed. */ - "dependabot-alert-sort": "created" | "updated"; + "dependabot-alert-sort"?: "created" | "updated"; /** * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ - "pagination-first": number; + "pagination-first"?: number; /** * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. * This parameter must not be used in combination with `first`. * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ - "pagination-last": number; + "pagination-last"?: number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; + "secret-scanning-alert-state"?: "open" | "resolved"; /** * @description A comma-separated list of secret types to return. By default all secret types are returned. * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.8/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" * for a complete list of secret types. */ - "secret-scanning-alert-secret-type": string; + "secret-scanning-alert-secret-type"?: string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; + "secret-scanning-alert-resolution"?: string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "secret-scanning-alert-sort": "created" | "updated"; + "secret-scanning-alert-sort"?: "created" | "updated"; /** @description The security feature to enable or disable. */ "enterprise-security-product": | "advanced_security" @@ -79185,35 +79185,35 @@ export interface components { /** @description The unique identifier of the comment. */ "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels: string; + labels?: string; /** @description The account owner of the repository. The name is not case sensitive. */ owner: string; /** @description The name of the repository. The name is not case sensitive. */ repo: string; /** @description If `true`, show notifications marked as read. */ - all: boolean; + all?: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating: boolean; + participating?: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before: string; + before?: string; /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.8/rest/reference/activity#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org": number; + "since-org"?: number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description The unique identifier of the required workflow. */ "required-workflow-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ - "visible-to-repository": string; + "visible-to-repository"?: string; /** @description The name of the secret. */ "secret-name": string; /** @description The number of results per page (max 30). */ - "variables-per-page": number; + "variables-per-page"?: number; /** @description The name of the variable. */ "variable-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.8/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase": string; + "audit-log-phrase"?: string; /** @description The unique identifier of the group. */ "group-id": number; /** @description The unique identifier of the migration. */ @@ -79221,9 +79221,9 @@ export interface components { /** @description repo_name parameter */ "repo-name": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.8/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - "secret-scanning-pagination-before-org-repo": string; + "secret-scanning-pagination-before-org-repo"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.8/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - "secret-scanning-pagination-after-org-repo": string; + "secret-scanning-pagination-after-org-repo"?: string; /** @description The slug of the team name. */ "team-slug": string; /** @description The number that identifies the discussion. */ @@ -79258,11 +79258,11 @@ export interface components { /** @description The unique identifier of the artifact. */ "artifact-id": number; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - "actions-cache-git-ref-full": string; + "actions-cache-git-ref-full"?: string; /** @description An explicit key or prefix for identifying the cache */ - "actions-cache-key": string; + "actions-cache-key"?: string; /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ - "actions-cache-list-sort": + "actions-cache-list-sort"?: | "created_at" | "last_accessed_at" | "size_in_bytes"; @@ -79273,13 +79273,13 @@ export interface components { /** @description The unique identifier of the job. */ "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor: string; + actor?: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch": string; + "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.8/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event: string; + event?: string; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ - "workflow-run-status": + "workflow-run-status"?: | "completed" | "action_required" | "cancelled" @@ -79295,13 +79295,13 @@ export interface components { | "waiting" | "pending"; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.8/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created: string; + created?: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests": boolean; + "exclude-pull-requests"?: boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id": number; + "workflow-run-check-suite-id"?: number; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - "workflow-run-head-sha": string; + "workflow-run-head-sha"?: string; /** @description The unique identifier of the workflow run. */ "run-id": number; /** @description The attempt number of the workflow run. */ @@ -79317,17 +79317,17 @@ export interface components { /** @description The unique identifier of the check suite. */ "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - "check-name": string; + "check-name"?: string; /** @description Returns check runs with the specified `status`. */ - status: "queued" | "in_progress" | "completed"; + status?: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - "git-ref": components["schemas"]["code-scanning-ref"]; + "git-ref"?: components["schemas"]["code-scanning-ref"]; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ "commit-sha": string; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ - "dependabot-alert-comma-separated-manifests": string; + "dependabot-alert-comma-separated-manifests"?: string; /** * @description The number that identifies a Dependabot alert in its repository. * You can find this at the end of the URL for a Dependabot alert within GitHub, @@ -79336,7 +79336,7 @@ export interface components { */ "dependabot-alert-number": components["schemas"]["alert-number"]; /** @description The full path, relative to the repository root, of the dependency manifest file. */ - "manifest-path": string; + "manifest-path"?: string; /** @description deployment_id parameter */ "deployment-id": number; /** @description The name of the environment. */ @@ -79346,7 +79346,7 @@ export interface components { /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ - sort: "created" | "updated"; + sort?: "created" | "updated"; /** @description The number that identifies the issue. */ "issue-number": number; /** @description The unique identifier of the key. */ @@ -79364,31 +79364,31 @@ export interface components { /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo": number; + "since-repo"?: number; /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ - "excluded-attributes": string; + "excluded-attributes"?: string; /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ - "start-index": number; + "start-index"?: number; /** @description Used for pagination: the number of results to return per page. */ - count: number; + count?: number; /** @description A unique identifier of the SCIM group. */ "scim-group-id": string; /** @description The unique identifier of the SCIM user. */ "scim-user-id": string; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order: "desc" | "asc"; + order?: "desc" | "asc"; /** @description The unique identifier of the GPG key. */ "gpg-key-id": number; /** @description Only show repositories 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-repo-date": string; + "since-repo-date"?: string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "before-repo-date": string; + "before-repo-date"?: string; /** @description The unique identifier of the SSH signing key. */ "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - "sort-starred": "created" | "updated"; + "sort-starred"?: "created" | "updated"; /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user": number; + "since-user"?: number; }; requestBodies: never; headers: { @@ -79970,11 +79970,11 @@ export interface operations { script: string; /** @description The GitHub repository where the script is kept. */ script_repository: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The pre-receive environment where the script is executed. */ environment: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The state of enforcement for this hook. default: `disabled` */ enforcement?: string; @@ -80036,11 +80036,11 @@ export interface operations { script?: string; /** @description The GitHub repository where the script is kept. */ script_repository?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The pre-receive environment where the script is executed. */ environment?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** @description The state of enforcement for this hook. */ enforcement?: string; @@ -80254,7 +80254,7 @@ export interface operations { client_secret: string; webhook_secret: string | null; pem: string; - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -82724,44 +82724,40 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The description of the gist. - * @example Example Ruby script - */ - description?: string; - /** - * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - * (including extension) of the targeted gist file. For example: `hello.py`. - * - * To delete a file, set the whole file to null. For example: `hello.py : null`. - * @example { - * "hello.rb": { - * "content": "blah", - * "filename": "goodbye.rb" - * } - * } - */ - files?: { - [key: string]: - | ( - | ({ - /** @description The new content of the file. */ - content?: string; - /** @description The new filename for the file. */ - filename?: string | null; - } & ( - | Record - | Record - | Record - )) - | null - ) - | undefined; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The description of the gist. + * @example Example Ruby script + */ + description?: string; + /** + * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename + * (including extension) of the targeted gist file. For example: `hello.py`. + * + * To delete a file, set the whole file to null. For example: `hello.py : null`. + * @example { + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } + */ + files?: { + [key: string]: + | OneOf< + [ + { + /** @description The new content of the file. */ + content?: string; + /** @description The new filename for the file. */ + filename?: string | null; + }, + Record + ] + > + | undefined; + }; + } | null; }; }; responses: { @@ -91310,7 +91306,7 @@ export interface operations { ref: string; /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ inputs?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -92666,12 +92662,12 @@ export interface operations { { /** @enum {unknown} */ status: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; }, { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ] >; @@ -92816,12 +92812,12 @@ export interface operations { | { /** @enum {unknown} */ status?: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; } | { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ); }; @@ -93278,7 +93274,7 @@ export interface operations { content: { "application/json": components["schemas"]["code-scanning-analysis"]; "application/json+sarif": { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -95076,7 +95072,7 @@ export interface operations { payload?: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -95318,7 +95314,7 @@ export interface operations { event_type: string; /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ client_payload?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -98374,13 +98370,7 @@ export interface operations { */ path: "/" | "/docs"; }; - } & ( - | Record - | Record - | Record - | Record - | Record - ); + }; }; }; responses: { @@ -98406,26 +98396,24 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path?: "/" | "/docs"; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path?: "/" | "/docs"; + }; + } | null; }; }; responses: { @@ -99441,7 +99429,7 @@ export interface operations { }; /** * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.8/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.8/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ "pulls/request-reviewers": { parameters: { @@ -99458,7 +99446,7 @@ export interface operations { reviewers?: string[]; /** @description An array of team `slug`s that will be requested. */ team_reviewers?: string[]; - } & (Record | Record); + }; }; }; responses: { diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json index b2d63d828..4f89c1bc4 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": "11.1.0" + "openapi-version": "11.1.1" } } diff --git a/packages/openapi-types-github.ae/types.d.ts b/packages/openapi-types-github.ae/types.d.ts index c84149cc2..e89a47ce5 100644 --- a/packages/openapi-types-github.ae/types.d.ts +++ b/packages/openapi-types-github.ae/types.d.ts @@ -4326,7 +4326,7 @@ export interface paths { get: operations["pulls/list-requested-reviewers"]; /** * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ post: operations["pulls/request-reviewers"]; /** Remove requested reviewers from a pull request */ @@ -8337,17 +8337,17 @@ export interface components { request: { /** @description The request headers sent with the webhook delivery. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The webhook payload. */ payload: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; }; response: { /** @description The response headers received when the delivery was made. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The response payload received. */ payload: string | null; @@ -9282,7 +9282,7 @@ export interface components { country_name?: string; }; data?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; org_id?: number; user_id?: number; @@ -9745,8 +9745,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; }; /** * Public User @@ -9894,8 +9894,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["nullable-simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; } | null; url?: string; forks_url?: string; @@ -15338,7 +15338,7 @@ export interface components { payload: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -18866,7 +18866,7 @@ export interface components { email?: string; verified?: boolean; }[]; - subkeys?: Record[]; + subkeys?: unknown[]; can_sign?: boolean; can_encrypt_comms?: boolean; can_encrypt_storage?: boolean; @@ -38089,7 +38089,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; npm_metadata?: { @@ -38347,7 +38347,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; package_files: { @@ -68817,7 +68817,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; npm_metadata?: { @@ -69013,7 +69013,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; package_files: { @@ -70346,7 +70346,7 @@ export interface components { action: string; branch: string; client_payload: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; enterprise?: components["schemas"]["enterprise"]; installation: components["schemas"]["simple-installation"]; @@ -73408,7 +73408,7 @@ export interface components { "webhook-workflow-dispatch": { enterprise?: components["schemas"]["enterprise"]; inputs: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple"]; @@ -75737,13 +75737,13 @@ export interface components { }; parameters: { /** @description The number of results per page (max 100). */ - "per-page": number; + "per-page"?: number; /** @description Page number of the results to fetch. */ - page: number; + page?: number; /** @description The unique identifier of the hook. */ "hook-id": number; /** @description The direction to sort the results by. */ - direction: "asc" | "desc"; + direction?: "asc" | "desc"; /** @description The unique identifier of the key. */ "key-ids": string; /** @description The organization name. The name is not case sensitive. */ @@ -75755,10 +75755,10 @@ export interface components { /** @description The handle for the GitHub user account. */ username: string; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor: string; + cursor?: string; "delivery-id": number; /** @description 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: string; + since?: string; /** @description The unique identifier of the installation. */ "installation-id": number; /** @description The client ID of the GitHub app. */ @@ -75770,63 +75770,63 @@ export interface components { /** @description The unique identifier of the organization. */ "org-id": number; /** @description Only return runner groups that are allowed to be used by this organization. */ - "visible-to-organization": string; + "visible-to-organization"?: string; /** @description Unique identifier of the self-hosted runner group. */ "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ "runner-id": number; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase": string; + "audit-log-phrase"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ - "audit-log-after": string; + "audit-log-after"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ - "audit-log-before": string; + "audit-log-before"?: string; /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - "audit-log-order": "desc" | "asc"; + "audit-log-order"?: "desc" | "asc"; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; + "secret-scanning-alert-state"?: "open" | "resolved"; /** * @description A comma-separated list of secret types to return. By default all secret types are returned. * See "[Secret scanning patterns](https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" * for a complete list of secret types. */ - "secret-scanning-alert-secret-type": string; + "secret-scanning-alert-secret-type"?: string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; + "secret-scanning-alert-resolution"?: string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "secret-scanning-alert-sort": "created" | "updated"; + "secret-scanning-alert-sort"?: "created" | "updated"; /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */ - "pagination-before": string; + "pagination-before"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */ - "pagination-after": string; + "pagination-after"?: string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels: string; + labels?: string; /** @description If `true`, show notifications marked as read. */ - all: boolean; + all?: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating: boolean; + participating?: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before: string; + before?: string; /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org": number; + "since-org"?: number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description The name of the secret. */ "secret-name": string; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + "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"]; + "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. */ @@ -75856,13 +75856,13 @@ export interface components { /** @description The unique identifier of the job. */ "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor: string; + actor?: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch": string; + "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/github-ae@latest/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event: string; + event?: string; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ - "workflow-run-status": + "workflow-run-status"?: | "completed" | "action_required" | "cancelled" @@ -75878,13 +75878,13 @@ export interface components { | "waiting" | "pending"; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/github-ae@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created: string; + created?: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests": boolean; + "exclude-pull-requests"?: boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id": number; + "workflow-run-check-suite-id"?: number; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - "workflow-run-head-sha": string; + "workflow-run-head-sha"?: string; /** @description The unique identifier of the workflow run. */ "run-id": number; /** @description The attempt number of the workflow run. */ @@ -75900,11 +75900,11 @@ export interface components { /** @description The unique identifier of the check suite. */ "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - "check-name": string; + "check-name"?: string; /** @description Returns check runs with the specified `status`. */ - status: "queued" | "in_progress" | "completed"; + status?: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - "git-ref": components["schemas"]["code-scanning-ref"]; + "git-ref"?: components["schemas"]["code-scanning-ref"]; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -75918,7 +75918,7 @@ export interface components { /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ - sort: "created" | "updated"; + sort?: "created" | "updated"; /** @description The number that identifies the issue. */ "issue-number": number; /** @description The unique identifier of the key. */ @@ -75934,19 +75934,19 @@ export interface components { /** @description The unique identifier of the release. */ "release-id": number; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order: "desc" | "asc"; + order?: "desc" | "asc"; /** @description The unique identifier of the team. */ "team-id": number; /** @description The unique identifier of the GPG key. */ "gpg-key-id": number; /** @description Only show repositories 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-repo-date": string; + "since-repo-date"?: string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "before-repo-date": string; + "before-repo-date"?: string; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - "sort-starred": "created" | "updated"; + "sort-starred"?: "created" | "updated"; /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user": number; + "since-user"?: number; }; requestBodies: never; headers: { @@ -76536,7 +76536,7 @@ export interface operations { client_secret: string; webhook_secret: string | null; pem: string; - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -78037,44 +78037,40 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The description of the gist. - * @example Example Ruby script - */ - description?: string; - /** - * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - * (including extension) of the targeted gist file. For example: `hello.py`. - * - * To delete a file, set the whole file to null. For example: `hello.py : null`. - * @example { - * "hello.rb": { - * "content": "blah", - * "filename": "goodbye.rb" - * } - * } - */ - files?: { - [key: string]: - | ( - | ({ - /** @description The new content of the file. */ - content?: string; - /** @description The new filename for the file. */ - filename?: string | null; - } & ( - | Record - | Record - | Record - )) - | null - ) - | undefined; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The description of the gist. + * @example Example Ruby script + */ + description?: string; + /** + * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename + * (including extension) of the targeted gist file. For example: `hello.py`. + * + * To delete a file, set the whole file to null. For example: `hello.py : null`. + * @example { + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } + */ + files?: { + [key: string]: + | OneOf< + [ + { + /** @description The new content of the file. */ + content?: string; + /** @description The new filename for the file. */ + filename?: string | null; + }, + Record + ] + > + | undefined; + }; + } | null; }; }; responses: { @@ -84167,7 +84163,7 @@ export interface operations { ref: string; /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ inputs?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -85480,12 +85476,12 @@ export interface operations { { /** @enum {unknown} */ status: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; }, { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ] >; @@ -85630,12 +85626,12 @@ export interface operations { | { /** @enum {unknown} */ status?: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; } | { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ); }; @@ -86091,7 +86087,7 @@ export interface operations { content: { "application/json": components["schemas"]["code-scanning-analysis"]; "application/json+sarif": { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -87494,7 +87490,7 @@ export interface operations { payload?: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -87736,7 +87732,7 @@ export interface operations { event_type: string; /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ client_payload?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -90788,13 +90784,7 @@ export interface operations { */ path: "/" | "/docs"; }; - } & ( - | Record - | Record - | Record - | Record - | Record - ); + }; }; }; responses: { @@ -90820,26 +90810,24 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path?: "/" | "/docs"; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path?: "/" | "/docs"; + }; + } | null; }; }; responses: { @@ -91705,7 +91693,7 @@ export interface operations { }; /** * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ "pulls/request-reviewers": { parameters: { @@ -91722,7 +91710,7 @@ export interface operations { reviewers?: string[]; /** @description An array of team `slug`s that will be requested. */ team_reviewers?: string[]; - } & (Record | Record); + }; }; }; responses: { diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json index b3f9a0cf1..7c2d5fc4f 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": "11.1.0" + "openapi-version": "11.1.1" } } diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index 061cbb01f..3d8c7101a 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -8503,17 +8503,17 @@ export interface components { request: { /** @description The request headers sent with the webhook delivery. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The webhook payload. */ payload: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; }; response: { /** @description The response headers received when the delivery was made. */ headers: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; /** @description The response payload received. */ payload: string | null; @@ -10524,8 +10524,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; }; /** * Public User @@ -10673,8 +10673,8 @@ export interface components { comments_url: string; owner?: components["schemas"]["nullable-simple-user"]; truncated?: boolean; - forks?: Record[]; - history?: Record[]; + forks?: unknown[]; + history?: unknown[]; } | null; url?: string; forks_url?: string; @@ -15837,7 +15837,7 @@ export interface components { payload: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -22379,7 +22379,7 @@ export interface components { email?: string; verified?: boolean; }[]; - subkeys?: Record[]; + subkeys?: unknown[]; can_sign?: boolean; can_encrypt_comms?: boolean; can_encrypt_storage?: boolean; @@ -42222,7 +42222,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; npm_metadata?: { @@ -42480,7 +42480,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; package_files: { @@ -75520,7 +75520,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; npm_metadata?: { @@ -75716,7 +75716,7 @@ export interface components { installation_command: string; manifest?: string; metadata: { - [key: string]: unknown | undefined; + [key: string]: unknown; }[]; name: string; package_files: { @@ -77057,7 +77057,7 @@ export interface components { action: string; branch: string; client_payload: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; enterprise?: components["schemas"]["enterprise"]; installation: components["schemas"]["simple-installation"]; @@ -80550,7 +80550,7 @@ export interface components { "webhook-workflow-dispatch": { enterprise?: components["schemas"]["enterprise"]; inputs: { - [key: string]: unknown | undefined; + [key: string]: unknown; } | null; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple"]; @@ -82967,14 +82967,14 @@ export interface components { }; parameters: { /** @description The number of results per page (max 100). */ - "per-page": number; + "per-page"?: number; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor: string; + cursor?: string; "delivery-id": number; /** @description Page number of the results to fetch. */ - page: number; + page?: number; /** @description 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: string; + since?: string; /** @description The unique identifier of the installation. */ "installation-id": number; /** @description The client ID of the GitHub app. */ @@ -82987,99 +82987,99 @@ export interface components { * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ - "dependabot-alert-comma-separated-states": string; + "dependabot-alert-comma-separated-states"?: string; /** * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * * Can be: `low`, `medium`, `high`, `critical` */ - "dependabot-alert-comma-separated-severities": string; + "dependabot-alert-comma-separated-severities"?: string; /** * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ - "dependabot-alert-comma-separated-ecosystems": string; + "dependabot-alert-comma-separated-ecosystems"?: string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - "dependabot-alert-comma-separated-packages": string; + "dependabot-alert-comma-separated-packages"?: string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - "dependabot-alert-scope": "development" | "runtime"; + "dependabot-alert-scope"?: "development" | "runtime"; /** * @description The property by which to sort the results. * `created` means when the alert was created. * `updated` means when the alert's state last changed. */ - "dependabot-alert-sort": "created" | "updated"; + "dependabot-alert-sort"?: "created" | "updated"; /** @description The direction to sort the results by. */ - direction: "asc" | "desc"; + direction?: "asc" | "desc"; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. */ - "pagination-before": string; + "pagination-before"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. */ - "pagination-after": string; + "pagination-after"?: string; /** * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ - "pagination-first": number; + "pagination-first"?: number; /** * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. * This parameter must not be used in combination with `first`. * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ - "pagination-last": number; + "pagination-last"?: number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; + "secret-scanning-alert-state"?: "open" | "resolved"; /** * @description A comma-separated list of secret types to return. By default all secret types are returned. * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" * for a complete list of secret types. */ - "secret-scanning-alert-secret-type": string; + "secret-scanning-alert-secret-type"?: string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; + "secret-scanning-alert-resolution"?: string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "secret-scanning-alert-sort": "created" | "updated"; + "secret-scanning-alert-sort"?: "created" | "updated"; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels: string; + labels?: string; /** @description account_id parameter */ "account-id": number; /** @description The unique identifier of the plan. */ "plan-id": number; /** @description The property to sort the results by. */ - sort: "created" | "updated"; + sort?: "created" | "updated"; /** @description The account owner of the repository. The name is not case sensitive. */ owner: string; /** @description The name of the repository. The name is not case sensitive. */ repo: string; /** @description If `true`, show notifications marked as read. */ - all: boolean; + all?: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating: boolean; + participating?: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before: string; + before?: string; /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org": number; + "since-org"?: number; /** @description The organization name. The name is not case sensitive. */ org: string; /** @description The property by which to sort the results. */ - "personal-access-token-sort": "created_at"; + "personal-access-token-sort"?: "created_at"; /** @description A list of owner usernames to use to filter the results. */ - "personal-access-token-owner": string[]; + "personal-access-token-owner"?: string[]; /** @description The name of the repository to use to filter the results. */ - "personal-access-token-repository": string; + "personal-access-token-repository"?: string; /** @description The permission to use to filter the results. */ - "personal-access-token-permission": string; + "personal-access-token-permission"?: string; /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "personal-access-token-before": string; + "personal-access-token-before"?: string; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "personal-access-token-after": string; + "personal-access-token-after"?: string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; /** @description The unique identifier of the repository. */ @@ -83093,15 +83093,15 @@ export interface components { /** @description The name of the secret. */ "secret-name": string; /** @description The number of results per page (max 30). */ - "variables-per-page": number; + "variables-per-page"?: number; /** @description The name of the variable. */ "variable-name": string; /** @description The handle for the GitHub user account. */ username: string; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + "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"]; + "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"]; /** @description The unique identifier of the hook. */ "hook-id": number; /** @description The unique identifier of the invitation. */ @@ -83118,7 +83118,7 @@ export interface components { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ - "package-visibility": "public" | "private" | "internal"; + "package-visibility"?: "public" | "private" | "internal"; /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ "package-type": | "npm" @@ -83132,9 +83132,9 @@ export interface components { /** @description Unique identifier of the package version. */ "package-version-id": number; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - "secret-scanning-pagination-before-org-repo": string; + "secret-scanning-pagination-before-org-repo"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - "secret-scanning-pagination-after-org-repo": string; + "secret-scanning-pagination-after-org-repo"?: string; /** @description The slug of the team name. */ "team-slug": string; /** @description The number that identifies the discussion. */ @@ -83170,11 +83170,11 @@ export interface components { /** @description The unique identifier of the artifact. */ "artifact-id": number; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - "actions-cache-git-ref-full": string; + "actions-cache-git-ref-full"?: string; /** @description An explicit key or prefix for identifying the cache */ - "actions-cache-key": string; + "actions-cache-key"?: string; /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ - "actions-cache-list-sort": + "actions-cache-list-sort"?: | "created_at" | "last_accessed_at" | "size_in_bytes"; @@ -83185,13 +83185,13 @@ export interface components { /** @description The unique identifier of the job. */ "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor: string; + actor?: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch": string; + "workflow-run-branch"?: string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event: string; + event?: string; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ - "workflow-run-status": + "workflow-run-status"?: | "completed" | "action_required" | "cancelled" @@ -83207,13 +83207,13 @@ export interface components { | "waiting" | "pending"; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created: string; + created?: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests": boolean; + "exclude-pull-requests"?: boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id": number; + "workflow-run-check-suite-id"?: number; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - "workflow-run-head-sha": string; + "workflow-run-head-sha"?: string; /** @description The unique identifier of the workflow run. */ "run-id": number; /** @description The attempt number of the workflow run. */ @@ -83229,17 +83229,17 @@ export interface components { /** @description The unique identifier of the check suite. */ "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - "check-name": string; + "check-name"?: string; /** @description Returns check runs with the specified `status`. */ - status: "queued" | "in_progress" | "completed"; + status?: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - "git-ref": components["schemas"]["code-scanning-ref"]; + "git-ref"?: components["schemas"]["code-scanning-ref"]; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ "commit-sha": string; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ - "dependabot-alert-comma-separated-manifests": string; + "dependabot-alert-comma-separated-manifests"?: string; /** * @description The number that identifies a Dependabot alert in its repository. * You can find this at the end of the URL for a Dependabot alert within GitHub, @@ -83248,7 +83248,7 @@ export interface components { */ "dependabot-alert-number": components["schemas"]["alert-number"]; /** @description The full path, relative to the repository root, of the dependency manifest file. */ - "manifest-path": string; + "manifest-path"?: string; /** @description deployment_id parameter */ "deployment-id": number; /** @description The name of the environment. */ @@ -83258,7 +83258,7 @@ export interface components { /** @description The unique identifier of the protection rule. */ "protection-rule-id": number; /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user": number; + "since-user"?: number; /** @description The number that identifies the issue. */ "issue-number": number; /** @description The unique identifier of the key. */ @@ -83278,27 +83278,27 @@ export interface components { /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description The time frame to display results for. */ - per: "day" | "week"; + per?: "day" | "week"; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo": number; + "since-repo"?: number; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order: "desc" | "asc"; + order?: "desc" | "asc"; /** @description The unique identifier of the team. */ "team-id": number; /** @description ID of the Repository to filter on */ - "repository-id-in-query": number; + "repository-id-in-query"?: number; /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ "export-id": string; /** @description The unique identifier of the GPG key. */ "gpg-key-id": number; /** @description Only show repositories 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-repo-date": string; + "since-repo-date"?: string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "before-repo-date": string; + "before-repo-date"?: string; /** @description The unique identifier of the SSH signing key. */ "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - "sort-starred": "created" | "updated"; + "sort-starred"?: "created" | "updated"; }; requestBodies: never; headers: { @@ -83372,7 +83372,7 @@ export interface operations { client_secret: string; webhook_secret: string | null; pem: string; - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -84186,44 +84186,40 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The description of the gist. - * @example Example Ruby script - */ - description?: string; - /** - * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - * (including extension) of the targeted gist file. For example: `hello.py`. - * - * To delete a file, set the whole file to null. For example: `hello.py : null`. - * @example { - * "hello.rb": { - * "content": "blah", - * "filename": "goodbye.rb" - * } - * } - */ - files?: { - [key: string]: - | ( - | ({ - /** @description The new content of the file. */ - content?: string; - /** @description The new filename for the file. */ - filename?: string | null; - } & ( - | Record - | Record - | Record - )) - | null - ) - | undefined; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The description of the gist. + * @example Example Ruby script + */ + description?: string; + /** + * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename + * (including extension) of the targeted gist file. For example: `hello.py`. + * + * To delete a file, set the whole file to null. For example: `hello.py : null`. + * @example { + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } + */ + files?: { + [key: string]: + | OneOf< + [ + { + /** @description The new content of the file. */ + content?: string; + /** @description The new filename for the file. */ + filename?: string | null; + }, + Record + ] + > + | undefined; + }; + } | null; }; }; responses: { @@ -93975,7 +93971,7 @@ export interface operations { ref: string; /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ inputs?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -95386,12 +95382,12 @@ export interface operations { { /** @enum {unknown} */ status: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; }, { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ] >; @@ -95536,12 +95532,12 @@ export interface operations { | { /** @enum {unknown} */ status?: "completed"; - [key: string]: unknown | undefined; + [key: string]: unknown; } | { /** @enum {unknown} */ status?: "queued" | "in_progress"; - [key: string]: unknown | undefined; + [key: string]: unknown; } ); }; @@ -95998,7 +95994,7 @@ export interface operations { content: { "application/json": components["schemas"]["code-scanning-analysis"]; "application/json+sarif": { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -98394,7 +98390,7 @@ export interface operations { payload?: OneOf< [ { - [key: string]: unknown | undefined; + [key: string]: unknown; }, string ] @@ -98636,7 +98632,7 @@ export interface operations { event_type: string; /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ client_payload?: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; }; }; @@ -102216,13 +102212,7 @@ export interface operations { */ path: "/" | "/docs"; }; - } & ( - | Record - | Record - | Record - | Record - | Record - ); + }; }; }; responses: { @@ -102248,26 +102238,24 @@ export interface operations { }; requestBody: { content: { - "application/json": - | ({ - /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path?: "/" | "/docs"; - }; - } & (Record | Record)) - | null; + "application/json": { + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path?: "/" | "/docs"; + }; + } | null; }; }; responses: { @@ -103300,7 +103288,7 @@ export interface operations { reviewers?: string[]; /** @description An array of team `slug`s that will be requested. */ team_reviewers?: string[]; - } & (Record | Record); + }; }; }; responses: {