diff --git a/cache/openapi-schema.json b/cache/openapi-schema.json index 234c544ec..9e2f17023 100644 --- a/cache/openapi-schema.json +++ b/cache/openapi-schema.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "2.3.1", + "version": "2.4.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -3301,7 +3301,7 @@ "description": "response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/gist-full" }, + "schema": { "$ref": "#/components/schemas/gist-simple" }, "examples": { "default": { "$ref": "#/components/examples/gist" } } @@ -3435,7 +3435,7 @@ "description": "response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/gist-full" }, + "schema": { "$ref": "#/components/schemas/gist-simple" }, "examples": { "default": { "$ref": "#/components/examples/gist" } } @@ -3486,6 +3486,7 @@ "type": "object", "additionalProperties": { "type": "object", + "nullable": true, "properties": { "content": { "description": "The new content of the file", @@ -3497,8 +3498,11 @@ "nullable": true } }, - "additionalProperties": false, - "nullable": true + "anyOf": [ + { "required": ["content"] }, + { "required": ["filename"] }, + { "type": "object", "maxProperties": 0 } + ] } } }, @@ -3517,7 +3521,7 @@ "description": "response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/gist-full" }, + "schema": { "$ref": "#/components/schemas/gist-simple" }, "examples": { "default": { "$ref": "#/components/examples/gist" } } @@ -3864,7 +3868,7 @@ "application/json": { "schema": { "type": "array", - "items": { "$ref": "#/components/schemas/gist-full" } + "items": { "$ref": "#/components/schemas/gist-simple" } }, "examples": { "default": { "$ref": "#/components/examples/gist-fork-items" } @@ -4041,7 +4045,7 @@ "description": "response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/gist-full" }, + "schema": { "$ref": "#/components/schemas/gist-simple" }, "examples": { "default": { "$ref": "#/components/examples/gist" } } @@ -7187,6 +7191,53 @@ "x-octokit": {} } }, + "/orgs/{org}/failed_invitations": { + "get": { + "summary": "List failed organization invitations", + "description": "The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.", + "tags": ["orgs"], + "operationId": "orgs/list-failed-invitations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-failed-organization-invitations" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-invitation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-invitation-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + } + }, "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", @@ -7839,7 +7890,7 @@ }, "post": { "summary": "Create an organization invitation", - "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": ["orgs"], "operationId": "orgs/create-invitation", "externalDocs": { @@ -7912,6 +7963,36 @@ "x-octokit": {} } }, + "/orgs/{org}/invitations/{invitation_id}": { + "delete": { + "summary": "Cancel an organization invitation", + "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications).", + "tags": ["orgs"], + "operationId": "orgs/cancel-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#cancel-an-organization-invitation" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/invitation_id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + } + }, "/orgs/{org}/invitations/{invitation_id}/teams": { "get": { "summary": "List organization invitation teams", @@ -9762,7 +9843,7 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "tags": ["teams"], "operationId": "teams/create-discussion-in-org", "externalDocs": { @@ -10020,7 +10101,7 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": ["teams"], "operationId": "teams/create-discussion-comment-in-org", "externalDocs": { @@ -17640,7 +17721,7 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": ["repos"], "operationId": "repos/add-collaborator", "externalDocs": { @@ -18315,7 +18396,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": ["repos"], "operationId": "repos/create-commit-comment", "externalDocs": { @@ -18466,7 +18547,8 @@ "description": "ref+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true } ], "responses": { @@ -18513,7 +18595,8 @@ "description": "ref+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true }, { "$ref": "#/components/parameters/check_name" }, { "$ref": "#/components/parameters/status" }, @@ -18585,7 +18668,8 @@ "description": "ref+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true }, { "name": "app_id", @@ -18653,7 +18737,8 @@ "description": "ref+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true } ], "responses": { @@ -18702,7 +18787,8 @@ "description": "ref+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true }, { "$ref": "#/components/parameters/per_page" }, { "$ref": "#/components/parameters/page" } @@ -18889,7 +18975,8 @@ "description": "path+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true }, { "name": "ref", @@ -18962,7 +19049,8 @@ "description": "path+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true } ], "requestBody": { @@ -19113,7 +19201,8 @@ "description": "path+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true } ], "requestBody": { @@ -19375,9 +19464,14 @@ "items": { "type": "string" } }, "payload": { - "type": "string", - "description": "JSON payload with extra information about the deployment.", - "default": "" + "oneOf": [ + { "type": "object", "additionalProperties": true }, + { + "type": "string", + "description": "JSON payload with extra information about the deployment.", + "default": "" + } + ] }, "environment": { "type": "string", @@ -19822,7 +19916,7 @@ "/repos/{owner}/{repo}/dispatches": { "post": { "summary": "Create a repository dispatch event", - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nTo give you write access to the repository, you must use a personal access token with the `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", + "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis endpoint requires write access to the repository by providing either:\n\n - Personal access tokens with `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", "tags": ["repos"], "operationId": "repos/create-dispatch-event", "externalDocs": { @@ -20318,7 +20412,8 @@ "description": "ref+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true }, { "$ref": "#/components/parameters/per_page" }, { "$ref": "#/components/parameters/page" } @@ -20368,7 +20463,8 @@ "description": "ref+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true } ], "responses": { @@ -20485,7 +20581,8 @@ "description": "ref+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true } ], "requestBody": { @@ -20553,7 +20650,8 @@ "description": "ref+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true } ], "responses": { @@ -22176,7 +22274,7 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": ["issues"], "operationId": "issues/create", "externalDocs": { @@ -22194,7 +22292,7 @@ "type": "object", "properties": { "title": { - "type": "string", + "oneOf": [{ "type": "string" }, { "type": "integer" }], "description": "The title of the issue." }, "body": { @@ -22207,8 +22305,13 @@ "nullable": true }, "milestone": { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._", + "oneOf": [ + { "type": "string" }, + { + "type": "integer", + "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" + } + ], "nullable": true }, "labels": { @@ -22222,8 +22325,11 @@ "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, - "description": { "type": "string" }, - "color": { "type": "string" } + "description": { + "type": "string", + "nullable": true + }, + "color": { "type": "string", "nullable": true } } } ] @@ -22825,7 +22931,7 @@ "type": "object", "properties": { "title": { - "type": "string", + "oneOf": [{ "type": "string" }, { "type": "integer" }], "description": "The title of the issue." }, "body": { @@ -22834,6 +22940,7 @@ }, "assignee": { "type": "string", + "nullable": true, "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**" }, "state": { @@ -22842,8 +22949,13 @@ "enum": ["open", "closed"] }, "milestone": { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._", + "oneOf": [ + { "type": "string" }, + { + "type": "integer", + "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._" + } + ], "nullable": true }, "labels": { @@ -22857,8 +22969,11 @@ "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, - "description": { "type": "string" }, - "color": { "type": "string" } + "description": { + "type": "string", + "nullable": true + }, + "color": { "type": "string", "nullable": true } } } ] @@ -23075,7 +23190,7 @@ }, "post": { "summary": "Create an issue comment", - "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": ["issues"], "operationId": "issues/create-comment", "externalDocs": { @@ -23451,6 +23566,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "lock_reason": { "type": "string", @@ -24931,6 +25047,10 @@ "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).\"", "nullable": true }, + "public": { + "type": "boolean", + "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. This feature is only available to repositories in an organization on an Enterprise plan." + }, "source": { "anyOf": [ { @@ -25405,7 +25525,7 @@ }, "post": { "summary": "Create a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": ["pulls"], "operationId": "pulls/create", "externalDocs": { @@ -26074,7 +26194,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": ["pulls"], "operationId": "pulls/create-review-comment", "externalDocs": { @@ -26202,7 +26322,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": ["pulls"], "operationId": "pulls/create-reply-for-review-comment", "externalDocs": { @@ -26716,7 +26836,7 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", "tags": ["pulls"], "operationId": "pulls/create-review", "externalDocs": { @@ -27308,7 +27428,7 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": ["repos"], "operationId": "repos/create-release", "externalDocs": { @@ -27573,7 +27693,8 @@ "description": "tag+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true } ], "responses": { @@ -28302,7 +28423,8 @@ "name": "sha", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true } ], "requestBody": { @@ -28969,14 +29091,15 @@ "properties": { "new_owner": { "type": "string", - "description": "**Required:** The username or organization name the repository will be transferred to." + "description": "The username or organization name the repository will be transferred to." }, "team_ids": { "type": "array", "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", "items": { "type": "integer" } } - } + }, + "required": ["new_owner"] }, "example": { "new_owner": "github", "team_ids": [12, 345] } } @@ -31214,7 +31337,7 @@ }, "post": { "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": ["teams"], "operationId": "teams/create-discussion-legacy", "externalDocs": { @@ -31480,7 +31603,7 @@ }, "post": { "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": ["teams"], "operationId": "teams/create-discussion-comment-legacy", "externalDocs": { @@ -39224,150 +39347,6 @@ "truncated": { "type": "boolean" } } }, - "gist-full": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { "$ref": "#/components/schemas/gist-simple" }, - { - "type": "object", - "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { "type": "string" }, - "id": { "type": "integer" }, - "node_id": { "type": "string" }, - "avatar_url": { "type": "string" }, - "gravatar_id": { "type": "string" }, - "url": { "type": "string" }, - "html_url": { "type": "string" }, - "followers_url": { "type": "string" }, - "following_url": { "type": "string" }, - "gists_url": { "type": "string" }, - "starred_url": { "type": "string" }, - "subscriptions_url": { "type": "string" }, - "organizations_url": { "type": "string" }, - "repos_url": { "type": "string" }, - "events_url": { "type": "string" }, - "received_events_url": { "type": "string" }, - "type": { "type": "string" }, - "site_admin": { "type": "boolean" } - } - }, - "url": { "type": "string" }, - "id": { "type": "string" }, - "created_at": { "type": "string" }, - "updated_at": { "type": "string" } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { "type": "string" }, - "version": { "type": "string" }, - "user": { - "type": "object", - "properties": { - "login": { "type": "string" }, - "id": { "type": "integer" }, - "node_id": { "type": "string" }, - "avatar_url": { "type": "string" }, - "gravatar_id": { "type": "string" }, - "url": { "type": "string" }, - "html_url": { "type": "string" }, - "followers_url": { "type": "string" }, - "following_url": { "type": "string" }, - "gists_url": { "type": "string" }, - "starred_url": { "type": "string" }, - "subscriptions_url": { "type": "string" }, - "organizations_url": { "type": "string" }, - "repos_url": { "type": "string" }, - "events_url": { "type": "string" }, - "received_events_url": { "type": "string" }, - "type": { "type": "string" }, - "site_admin": { "type": "boolean" } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { "type": "integer" }, - "additions": { "type": "integer" }, - "total": { "type": "integer" } - } - }, - "committed_at": { "type": "string" } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [{ "$ref": "#/components/schemas/gist-simple" }] - }, - "url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" - }, - "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" - } - } - } - ] - }, "gist-comment": { "title": "Gist Comment", "description": "A comment made to a gist.", @@ -40568,6 +40547,42 @@ "credential_authorized_at" ] }, + "organization-invitation": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { "type": "integer" }, + "login": { "type": "string", "nullable": true }, + "email": { "type": "string", "nullable": true }, + "role": { "type": "string" }, + "created_at": { "type": "string" }, + "failed_at": { "type": "string" }, + "failed_reason": { "type": "string" }, + "inviter": { "$ref": "#/components/schemas/simple-user" }, + "team_count": { "type": "integer" }, + "invitation_team_url": { "type": "string" }, + "node_id": { + "type": "string", + "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + }, + "invitation_teams_url": { + "type": "string", + "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_team_url", + "node_id" + ] + }, "org-hook": { "title": "Org Hook", "description": "Org Hook", @@ -40665,40 +40680,6 @@ }, "required": ["limit"] }, - "organization-invitation": { - "title": "Organization Invitation", - "description": "Organization Invitation", - "type": "object", - "properties": { - "id": { "type": "integer" }, - "login": { "type": "string", "nullable": true }, - "email": { "type": "string", "nullable": true }, - "role": { "type": "string" }, - "created_at": { "type": "string" }, - "inviter": { "$ref": "#/components/schemas/simple-user" }, - "team_count": { "type": "integer" }, - "invitation_team_url": { "type": "string" }, - "node_id": { - "type": "string", - "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - }, - "invitation_teams_url": { - "type": "string", - "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" - } - }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_team_url", - "node_id" - ] - }, "team-simple": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", @@ -46250,9 +46231,14 @@ "format": "uri", "example": "https://example.com" }, - "source": { "$ref": "#/components/schemas/pages-source-hash" } + "source": { "$ref": "#/components/schemas/pages-source-hash" }, + "public": { + "type": "boolean", + "description": "Whether the GitHub Pages site is publicly visible. If 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.", + "example": true + } }, - "required": ["url", "status", "cname", "custom_404"] + "required": ["url", "status", "cname", "custom_404", "public"] }, "page-build": { "title": "Page Build", @@ -50488,10 +50474,50 @@ "gist-fork-items": { "value": [ { - "url": "https://api.github.com/gists/dee9c42e4998ce2ea439", - "id": "dee9c42e4998ce2ea439", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z" + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 1, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } ] }, @@ -51839,6 +51865,42 @@ } ] }, + "organization-invitation-items": { + "value": [ + { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + }, + "team_count": 2, + "invitation_team_url": "https://api.github.com/organizations/2/invitations/1/teams" + } + ] + }, "org-hook-items": { "value": [ { @@ -51984,40 +52046,6 @@ "expires_at": "2018-08-17T04:18:39Z" } }, - "organization-invitation-items": { - "value": [ - { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "inviter": { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - }, - "team_count": 2, - "invitation_team_url": "https://api.github.com/organizations/2/invitations/1/teams" - } - ] - }, "organization-invitation": { "value": { "id": 1, @@ -61268,7 +61296,8 @@ "cname": "developer.github.com", "custom_404": false, "html_url": "https://developer.github.com", - "source": { "branch": "master", "path": "/" } + "source": { "branch": "master", "path": "/" }, + "public": true } }, "page-build-items": { @@ -67177,7 +67206,8 @@ "description": "branch+ parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true }, "check_run_id": { "name": "check_run_id", @@ -67219,10 +67249,11 @@ }, "commit_sha": { "name": "commit_sha", - "description": "commit_sha+ parameter", + "description": "commit_sha parameter", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true }, "deployment_id": { "name": "deployment_id", diff --git a/generated/types.ts b/generated/types.ts index 6cd9fe1ca..d236494fe 100644 --- a/generated/types.ts +++ b/generated/types.ts @@ -371,6 +371,9 @@ export interface paths { "/orgs/{org}/events": { get: operations["activity/list-public-org-events"]; }; + "/orgs/{org}/failed_invitations": { + get: operations["orgs/list-failed-invitations"]; + }; "/orgs/{org}/hooks": { get: operations["orgs/list-webhooks"]; post: operations["orgs/create-webhook"]; @@ -402,6 +405,9 @@ export interface paths { get: operations["orgs/list-pending-invitations"]; post: operations["orgs/create-invitation"]; }; + "/orgs/{org}/invitations/{invitation_id}": { + delete: operations["orgs/cancel-invitation"]; + }; "/orgs/{org}/invitations/{invitation_id}/teams": { get: operations["orgs/list-invitation-teams"]; }; @@ -3418,7 +3424,7 @@ export interface operations { * response */ "201": { - "application/json": components["schemas"]["gist-full"]; + "application/json": components["schemas"]["gist-simple"]; }; "304": never; "403": unknown; @@ -3485,7 +3491,7 @@ export interface operations { * response */ "200": { - "application/json": components["schemas"]["gist-full"]; + "application/json": components["schemas"]["gist-simple"]; }; "304": never; "403": unknown; @@ -3510,7 +3516,7 @@ export interface operations { * response */ "200": { - "application/json": components["schemas"]["gist-full"]; + "application/json": components["schemas"]["gist-simple"]; }; "404": unknown; "422": unknown; @@ -3678,7 +3684,7 @@ export interface operations { * response */ "200": { - "application/json": components["schemas"]["gist-full"][]; + "application/json": components["schemas"]["gist-simple"][]; }; "304": never; "403": unknown; @@ -3775,7 +3781,7 @@ export interface operations { * response */ "200": { - "application/json": components["schemas"]["gist-full"]; + "application/json": components["schemas"]["gist-simple"]; }; "403": unknown; "404": unknown; @@ -5678,6 +5684,29 @@ export interface operations { }; }; }; + /** + * The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. + */ + "orgs/list-failed-invitations": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-invitation"][]; + }; + "404": unknown; + }; + }; "orgs/list-webhooks": { parameters: { path: { @@ -6018,7 +6047,7 @@ export interface operations { /** * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ "orgs/create-invitation": { parameters: { @@ -6060,6 +6089,27 @@ export interface operations { "422": unknown; }; }; + /** + * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). + */ + "orgs/cancel-invitation": { + parameters: { + path: { + org: components["parameters"]["org"]; + invitation_id: components["parameters"]["invitation_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + "422": unknown; + }; + }; /** * List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ @@ -7124,7 +7174,7 @@ export interface operations { /** * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. */ @@ -7266,7 +7316,7 @@ export interface operations { /** * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ @@ -11644,7 +11694,7 @@ export interface operations { }; }; /** - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. * * For more information the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". * @@ -12039,7 +12089,7 @@ export interface operations { /** * Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ "repos/create-commit-comment": { parameters: { @@ -12786,10 +12836,7 @@ export interface operations { * The [status](https://docs.github.com/rest/reference/repos#statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ required_contexts?: string[]; - /** - * JSON payload with extra information about the deployment. - */ - payload?: string; + payload?: { [key: string]: any } | string; /** * Name for the target deployment environment (e.g., `production`, `staging`, `qa`). */ @@ -12997,7 +13044,10 @@ export interface operations { * * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * - * To give you write access to the repository, you must use a personal access token with the `repo` scope. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. + * This endpoint requires write access to the repository by providing either: + * + * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. + * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. * * This input example shows how you can use the `client_payload` as a test to debug your workflow. */ @@ -14409,7 +14459,7 @@ export interface operations { /** * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. */ "issues/create": { parameters: { @@ -14423,7 +14473,7 @@ export interface operations { /** * The title of the issue. */ - title: string; + title: string | number; /** * The contents of the issue. */ @@ -14432,16 +14482,18 @@ export interface operations { * Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ assignee?: string | null; - /** - * The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._ - */ - milestone?: number | null; + milestone?: (string | number) | null; /** * Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ labels?: ( | string - | { id?: number; name?: string; description?: string; color?: string } + | { + id?: number; + name?: string; + description?: string | null; + color?: string | null; + } )[]; /** * Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ @@ -14747,7 +14799,7 @@ export interface operations { /** * The title of the issue. */ - title?: string; + title?: string | number; /** * The contents of the issue. */ @@ -14755,21 +14807,23 @@ export interface operations { /** * Login for the user that this issue should be assigned to. **This field is deprecated.** */ - assignee?: string; + assignee?: string | null; /** * State of the issue. Either `open` or `closed`. */ state?: "open" | "closed"; - /** - * The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._ - */ - milestone?: number | null; + milestone?: (string | number) | null; /** * Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ */ labels?: ( | string - | { id?: number; name?: string; description?: string; color?: string } + | { + id?: number; + name?: string; + description?: string | null; + color?: string | null; + } )[]; /** * Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ @@ -14876,7 +14930,7 @@ export interface operations { }; }; /** - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. */ "issues/create-comment": { parameters: { @@ -15813,6 +15867,10 @@ export interface operations { * Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/)." */ cname?: string | null; + /** + * 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. This feature is only available to repositories in an organization on an Enterprise plan. + */ + public?: boolean; source: Partial<"gh-pages" | "master" | "master /docs"> & Partial<{ /** @@ -16046,7 +16104,7 @@ export interface operations { * * You can create a new pull request. * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ "pulls/create": { parameters: { @@ -16417,7 +16475,7 @@ export interface operations { * * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ "pulls/create-review-comment": { parameters: { @@ -16478,7 +16536,7 @@ export interface operations { /** * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ "pulls/create-reply-for-review-comment": { parameters: { @@ -16742,7 +16800,7 @@ export interface operations { }; }; /** - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. * * Pull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response. * @@ -17055,7 +17113,7 @@ export interface operations { /** * Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ "repos/create-release": { parameters: { @@ -17948,9 +18006,9 @@ export interface operations { requestBody: { "application/json": { /** - * **Required:** The username or organization name the repository will be transferred to. + * The username or organization name the repository will be transferred to. */ - new_owner?: string; + new_owner: string; /** * ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. */ @@ -19240,7 +19298,7 @@ export interface operations { * * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ "teams/create-discussion-legacy": { parameters: { @@ -19377,7 +19435,7 @@ export interface operations { * * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ "teams/create-discussion-comment-legacy": { parameters: { @@ -22451,7 +22509,7 @@ export interface components { */ alert_number: components["schemas"]["alert-number"]; /** - * commit_sha+ parameter + * commit_sha parameter */ commit_sha: string; /** @@ -23721,81 +23779,6 @@ export interface components { owner?: components["schemas"]["simple-user"]; truncated?: boolean; }; - /** - * Gist Full - */ - "gist-full": components["schemas"]["gist-simple"] & { - forks?: { - user?: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - }; - url?: string; - id?: string; - created_at?: string; - updated_at?: string; - }[]; - history?: { - url?: string; - version?: string; - user?: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - } | null; - change_status?: { - deletions?: number; - additions?: number; - total?: number; - }; - committed_at?: string; - }[]; - fork_of?: components["schemas"]["gist-simple"] | null; - url?: string; - forks_url?: string; - commits_url?: string; - id?: string; - node_id?: string; - git_pull_url?: string; - git_push_url?: string; - html_url?: string; - created_at?: string; - updated_at?: string; - description?: string | null; - comments?: number; - comments_url?: string; - }; /** * A comment made to a gist. */ @@ -24260,6 +24243,23 @@ export interface components { */ authorized_credential_note?: string; }; + /** + * Organization Invitation + */ + "organization-invitation": { + id: number; + login: string | null; + email: string | null; + role: string; + created_at: string; + failed_at?: string; + failed_reason?: string; + inviter: components["schemas"]["simple-user"]; + team_count: number; + invitation_team_url: string; + node_id: string; + invitation_teams_url?: string; + }; /** * Org Hook */ @@ -24311,21 +24311,6 @@ export interface components { limit: components["schemas"]["interaction-group"]; expiry?: components["schemas"]["interaction-expiry"]; }; - /** - * Organization Invitation - */ - "organization-invitation": { - id: number; - login: string | null; - email: string | null; - role: string; - created_at: string; - inviter: components["schemas"]["simple-user"]; - team_count: number; - invitation_team_url: string; - node_id: string; - invitation_teams_url?: string; - }; /** * Groups of organization members that gives permissions on specified repositories. */ @@ -26602,6 +26587,10 @@ export interface components { */ html_url?: string; source?: components["schemas"]["pages-source-hash"]; + /** + * Whether the GitHub Pages site is publicly visible. If 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. + */ + public: boolean; }; /** * Page Build diff --git a/package.json b/package.json index 493fa25d1..9081375a1 100644 --- a/package.json +++ b/package.json @@ -23,6 +23,6 @@ "branches": "main" }, "octokit": { - "openapi-version": "2.3.1" + "openapi-version": "2.4.0" } }